org.apache.pulsar.transaction.coordinator

Interface TransactionMetadataStore

All Known Implementing Classes:

MLTransactionMetadataStore

@Beta
public interface TransactionMetadataStore

A store for storing all the transaction metadata.

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Void>	addAckedPartitionToTxn(org.apache.pulsar.client.api.transaction.TxnID txnid, List<TransactionSubscription> partitions) Add the acked partitions to transaction identified by txnid.
CompletableFuture<Void>	addProducedPartitionToTxn(org.apache.pulsar.client.api.transaction.TxnID txnid, List<String> partitions) Add the produced partitions to transaction identified by txnid.
CompletableFuture<Void>	closeAsync() Close the transaction metadata store.
TransactionCoordinatorID	getTransactionCoordinatorID() Get the transaction coordinator id.
CompletableFuture<TxnMeta>	getTxnMeta(org.apache.pulsar.client.api.transaction.TxnID txnid) Query the TxnMeta of a given transaction txnid.
default CompletableFuture<PulsarTransactionMetadata.TxnStatus>	getTxnStatus(org.apache.pulsar.client.api.transaction.TxnID txnid) Query the PulsarTransactionMetadata.TxnStatus of a given transaction txnid.
CompletableFuture<org.apache.pulsar.client.api.transaction.TxnID>	newTransaction(long timeoutInMills) Create a new transaction in the transaction metadata store.
CompletableFuture<Void>	updateTxnStatus(org.apache.pulsar.client.api.transaction.TxnID txnid, PulsarTransactionMetadata.TxnStatus newStatus, PulsarTransactionMetadata.TxnStatus expectedStatus) Update the transaction from expectedStatus to newStatus.

Method Detail

getTxnStatus

default CompletableFuture<PulsarTransactionMetadata.TxnStatus> getTxnStatus(org.apache.pulsar.client.api.transaction.TxnID txnid)

Query the PulsarTransactionMetadata.TxnStatus of a given transaction txnid.

Parameters:

txnid - transaction id

Returns:

a future represents the result of this operation. it returns PulsarTransactionMetadata.TxnStatus of the given transaction.

getTxnMeta

CompletableFuture<TxnMeta> getTxnMeta(org.apache.pulsar.client.api.transaction.TxnID txnid)

Query the TxnMeta of a given transaction txnid.

Parameters:

txnid - transaction id

Returns:

a future represents the result of this operation. it returns TxnMeta of the given transaction.

newTransaction

CompletableFuture<org.apache.pulsar.client.api.transaction.TxnID> newTransaction(long timeoutInMills)

Create a new transaction in the transaction metadata store.

Parameters:

timeoutInMills - the timeout duration of the transaction in mills

Returns:

a future represents the result of creating a new transaction. it returns TxnID as the identifier for identifying the transaction.

addProducedPartitionToTxn

CompletableFuture<Void> addProducedPartitionToTxn(org.apache.pulsar.client.api.transaction.TxnID txnid,
                                                  List<String> partitions)

Add the produced partitions to transaction identified by txnid.

Parameters:

txnid - transaction id

partitions - the list of partitions that a transaction produces to

Returns:

a future represents the result of this operation

addAckedPartitionToTxn

CompletableFuture<Void> addAckedPartitionToTxn(org.apache.pulsar.client.api.transaction.TxnID txnid,
                                               List<TransactionSubscription> partitions)

Add the acked partitions to transaction identified by txnid.

Parameters:

txnid - transaction id

partitions - the list of partitions that a transaction acknowledge to

Returns:

a future represents the result of the operation

updateTxnStatus

CompletableFuture<Void> updateTxnStatus(org.apache.pulsar.client.api.transaction.TxnID txnid,
                                        PulsarTransactionMetadata.TxnStatus newStatus,
                                        PulsarTransactionMetadata.TxnStatus expectedStatus)

Update the transaction from expectedStatus to newStatus.

If the current transaction status is not expectedStatus, the update will be failed.

Parameters:

txnid - TxnID for update txn status

newStatus - the new txn status that the transaction should be updated to

expectedStatus - the expected status that the transaction should be

Returns:

a future represents the result of the operation

getTransactionCoordinatorID

TransactionCoordinatorID getTransactionCoordinatorID()

Get the transaction coordinator id.

Returns:

transaction coordinator id

closeAsync

CompletableFuture<Void> closeAsync()

Close the transaction metadata store.

Returns:

a future represents the result of this operation