org.apache.flink.connector.jdbc.xa

Interface XaFacade

All Superinterfaces:

AutoCloseable, JdbcConnectionProvider, Serializable

@Internal
public interface XaFacade
extends JdbcConnectionProvider, Serializable, AutoCloseable

Facade to the XA operations relevant to sink.

Typical workflow:

1. open()
2. start(javax.transaction.xa.Xid) transaction
3. JdbcConnectionProvider.getConnection(), write some data
4. endAndPrepare(javax.transaction.xa.Xid) (or failAndRollback(javax.transaction.xa.Xid))
5. commit(javax.transaction.xa.Xid, boolean) / rollback(javax.transaction.xa.Xid)
6. AutoCloseable.close()

recover() can be used to get abandoned prepared transactions for cleanup.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	XaFacade.EmptyXaTransactionException Thrown by XaFacade when RM responds with XA_RDONLY indicating that the transaction doesn't include any changes.
static class	XaFacade.TransientXaException Indicates a transient or unknown failure from the resource manager (see XA_RBTRANSIENT, XAER_RMFAIL).

Method Summary

Modifier and Type	Method and Description
void	commit(Xid xid, boolean ignoreUnknown) Commit previously prepared transaction.
void	endAndPrepare(Xid xid) End and then prepare the transaction.
void	failAndRollback(Xid xid) End transaction as failed; in case of error, try to roll it back.
static XaFacade	fromXaDataSourceSupplier(java.util.function.Supplier<XADataSource> dataSourceSupplier, Integer timeoutSec, boolean transactionPerConnection)
boolean	isOpen()
void	open()
Collection<Xid>	recover() Note: this can block on some non-MVCC databases if there are ended not prepared transactions.
void	rollback(Xid xid) Rollback previously prepared transaction.
void	start(Xid xid) Start a new transaction.

Methods inherited from interface org.apache.flink.connector.jdbc.internal.connection.JdbcConnectionProvider

closeConnection, getConnection, getOrEstablishConnection, isConnectionValid, reestablishConnection

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

fromXaDataSourceSupplier

static XaFacade fromXaDataSourceSupplier(java.util.function.Supplier<XADataSource> dataSourceSupplier,
                                         Integer timeoutSec,
                                         boolean transactionPerConnection)

Returns:

a non-serializable instance.

open

void open()
   throws Exception

Throws:

Exception

isOpen

boolean isOpen()

start

void start(Xid xid)
    throws Exception

Start a new transaction.

Throws:

Exception

endAndPrepare

void endAndPrepare(Xid xid)
            throws Exception

End and then prepare the transaction. Transaction can't be resumed afterwards.

Throws:

Exception

commit

void commit(Xid xid,
            boolean ignoreUnknown)
     throws XaFacade.TransientXaException

Commit previously prepared transaction.

Parameters:

ignoreUnknown - whether to ignore XAER_NOTA error.

Throws:

XaFacade.TransientXaException

rollback

void rollback(Xid xid)
       throws XaFacade.TransientXaException

Rollback previously prepared transaction.

Throws:

XaFacade.TransientXaException

failAndRollback

void failAndRollback(Xid xid)
              throws XaFacade.TransientXaException

End transaction as failed; in case of error, try to roll it back.

Throws:

XaFacade.TransientXaException

recover

Collection<Xid> recover()
                 throws XaFacade.TransientXaException

Note: this can block on some non-MVCC databases if there are ended not prepared transactions.

Throws:

XaFacade.TransientXaException