Package com.couchbase.client.core.transaction

Class CoreTransactionAttemptContext

java.lang.Object

com.couchbase.client.core.transaction.CoreTransactionAttemptContext

@Internal
public class CoreTransactionAttemptContext
extends Object

Provides methods to allow an application's transaction logic to read, mutate, insert and delete documents, as well as commit or rollback the transaction.

Field Summary

Fields

Modifier and Type	Field	Description
static final Duration	DEFAULT_DELAY_RETRYING_OPERATION
static final byte[]	NEAR_EMPTY_BYTE_ARRAY
static final int	STATE_BITS_MASK_BITS
static final int	STATE_BITS_MASK_FINAL_ERROR
static final int	STATE_BITS_POSITION_FINAL_ERROR
static final int	TRANSACTION_STATE_BIT_APP_ROLLBACK_NOT_ALLOWED
static final int	TRANSACTION_STATE_BIT_COMMIT_NOT_ALLOWED
static final int	TRANSACTION_STATE_BIT_SHOULD_NOT_RETRY
static final int	TRANSACTION_STATE_BIT_SHOULD_NOT_ROLLBACK
static final int	UNSTAGING_PARALLELISM

Constructor Summary

Constructors

Constructor	Description
CoreTransactionAttemptContext(Core core, CoreTransactionContext overall, CoreMergedTransactionConfig config, String attemptId, Optional<SpanWrapper> parentSpan, CoreTransactionAttemptContextHooks hooks)

Method Summary

Modifier and Type	Method	Description
Optional<CollectionIdentifier>	atrCollection()
Optional<String>	atrId()
String	attemptId()	Returns the globally unique ID of this attempt, which may be useful for debugging and logging purposes.
void	commit()	Commits the transaction.
Core	core()
<T> T	doQueryOperation(String lockDebugIn, String statement, CoreQueryOptions opts, SpanWrapper pspan, BiFunction<Integer,SpanWrapper,T> op)	Doesn't need everything from doKVOperation, as queryWrapper already centralises a lot of logic
CoreTransactionGetResult	get(CollectionIdentifier collection, String id)	Gets a document with the specified id and from the specified Couchbase bucket.
List<CoreTransactionOptionalGetMultiResult>	getMultiAlgo(List<CoreTransactionGetMultiSpec> specs, CoreGetMultiOptions options, boolean replicasFromPreferredServerGroup)
reactor.core.publisher.Mono<List<CoreTransactionOptionalGetMultiResult>>	getMultiAlgoReactive(List<CoreTransactionGetMultiSpec> specs, CoreGetMultiOptions options, boolean replicasFromPreferredServerGroup)
CoreGetMultiSignal	getMultiDocumentFetch(CoreGetMultiState operationState)
Either<CoreTransactionOptionalGetMultiResult,CoreGetMultiSignal>	getMultiSingleDocumentFetch(CoreTransactionGetMultiSpec spec, CoreGetMultiState operationState)
reactor.core.publisher.Mono<CoreTransactionGetResult>	getReactive(CollectionIdentifier collection, String id)
CoreTransactionGetResult	getReplicaFromPreferredServerGroup(CollectionIdentifier collection, String id)
reactor.core.publisher.Mono<CoreTransactionGetResult>	getReplicaFromPreferredServerGroupReactive(CollectionIdentifier collection, String id)
CoreTransactionGetResult	insert(CollectionIdentifier collection, String id, byte[] content, int flagsToStage, CoreExpiry expiry, SpanWrapper pspan)	Inserts a new document into the specified Couchbase collection.
reactor.core.publisher.Mono<CoreTransactionGetResult>	insert(CollectionIdentifier collection, String id, byte[] content, SpanWrapper pspan)	Deprecated. in favor of insert(CollectionIdentifier, String, byte[], int, CoreExpiry, SpanWrapper) which takes an additional 'flags' argument.
reactor.core.publisher.Mono<CoreTransactionGetResult>	insertReactive(CollectionIdentifier collection, String id, byte[] content, int flagsToStage, CoreExpiry expiry, SpanWrapper pspan)
CoreTransactionLogger	logger()	Returns the CoreTransactionLogger used by this instance, so the developer can insert their own log messages.
TransactionOperationFailedException	operationFailed(boolean updateInternalState, TransactionOperationFailedException err)	Rollback errors rules: Errors during auto-rollback: do not update internal state, as the user cares more about the original error that provoked the rollback Errors during app-rollback: do update internal state.
TransactionOperationFailedException	operationFailed(TransactionOperationFailedException err)
CoreQueryResult	queryBlocking(String statement, CoreQueryContext qc, CoreQueryOptions options, boolean tximplicit)	Used by AttemptContext, buffers all query rows in-memory.
reactor.core.publisher.Mono<CoreQueryResult>	queryReactive(String statement, CoreQueryContext qc, CoreQueryOptions options, boolean tximplicit)
ClassicCoreReactiveQueryResult	queryWrapperLocked(int sidx, CoreQueryContext qc, String statement, CoreQueryOptions options, String hookPoint, boolean isBeginWork, boolean existingErrorCheck, com.couchbase.client.core.deps.com.fasterxml.jackson.databind.node.ObjectNode txdata, com.couchbase.client.core.deps.com.fasterxml.jackson.databind.node.ArrayNode params, SpanWrapper span, boolean tximplicit, boolean updateInternalState)	This will return a TransactionOperationFailedException if that's what query returns, else will return the error after passing through convertQueryError.
protected String	randomAtrIdForVbucket(CoreTransactionAttemptContext self, Integer vbucketIdForDoc, int numAtrs)
void	remove(CoreTransactionGetResult doc, SpanWrapper pspan)	Removes the specified doc, using the document's last CoreTransactionGetResult.cas().
reactor.core.publisher.Mono<Void>	removeReactive(CoreTransactionGetResult doc, SpanWrapper pspan)
CoreTransactionGetResult	replace(CoreTransactionGetResult doc, byte[] content, int flags, CoreExpiry expiry, SpanWrapper pspan)	Mutates the specified doc with new content, using the document's last CoreTransactionGetResult.cas().
reactor.core.publisher.Mono<CoreTransactionGetResult>	replace(CoreTransactionGetResult doc, byte[] content, SpanWrapper pspan)	Deprecated. in favor of replace(CoreTransactionGetResult, byte[], int, CoreExpiry, SpanWrapper) which takes an additional 'flags' argument.
reactor.core.publisher.Mono<CoreTransactionGetResult>	replaceReactive(CoreTransactionGetResult doc, byte[] content, int flags, CoreExpiry expiry, SpanWrapper pspan)
void	rollback()	Rolls back the transaction.
RequestSpan	span()
String	toString()
String	transactionId()	Returns the globally unique ID of the overall transaction owning this attempt, which may be useful for debugging and logging purposes.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

NEAR_EMPTY_BYTE_ARRAY

public static final byte[] NEAR_EMPTY_BYTE_ARRAY

TRANSACTION_STATE_BIT_COMMIT_NOT_ALLOWED

public static final int TRANSACTION_STATE_BIT_COMMIT_NOT_ALLOWED

See Also:

• Constant Field Values

TRANSACTION_STATE_BIT_APP_ROLLBACK_NOT_ALLOWED

public static final int TRANSACTION_STATE_BIT_APP_ROLLBACK_NOT_ALLOWED

See Also:

• Constant Field Values

TRANSACTION_STATE_BIT_SHOULD_NOT_ROLLBACK

public static final int TRANSACTION_STATE_BIT_SHOULD_NOT_ROLLBACK

See Also:

• Constant Field Values

TRANSACTION_STATE_BIT_SHOULD_NOT_RETRY

public static final int TRANSACTION_STATE_BIT_SHOULD_NOT_RETRY

See Also:

• Constant Field Values

STATE_BITS_POSITION_FINAL_ERROR

public static final int STATE_BITS_POSITION_FINAL_ERROR

See Also:

• Constant Field Values

STATE_BITS_MASK_FINAL_ERROR

public static final int STATE_BITS_MASK_FINAL_ERROR

See Also:

• Constant Field Values

STATE_BITS_MASK_BITS

public static final int STATE_BITS_MASK_BITS

See Also:

• Constant Field Values

UNSTAGING_PARALLELISM

public static final int UNSTAGING_PARALLELISM

DEFAULT_DELAY_RETRYING_OPERATION

public static final Duration DEFAULT_DELAY_RETRYING_OPERATION

Constructor Details

CoreTransactionAttemptContext

public CoreTransactionAttemptContext(Core core,
 CoreTransactionContext overall,
 CoreMergedTransactionConfig config,
 String attemptId,
 Optional<SpanWrapper> parentSpan,
 CoreTransactionAttemptContextHooks hooks)

Method Details

core

public Core core()

attemptId

public String attemptId()

Returns the globally unique ID of this attempt, which may be useful for debugging and logging purposes.

transactionId

public String transactionId()

Returns the globally unique ID of the overall transaction owning this attempt, which may be useful for debugging and logging purposes.

get

public CoreTransactionGetResult get(CollectionIdentifier collection,
 String id)

Gets a document with the specified id and from the specified Couchbase bucket.

Parameters:

collection - the Couchbase collection the document exists on

id - the document's ID

Returns:

a CoreTransactionGetResult containing the document

getReactive

public reactor.core.publisher.Mono<CoreTransactionGetResult> getReactive(CollectionIdentifier collection,
 String id)

getReplicaFromPreferredServerGroup

public CoreTransactionGetResult getReplicaFromPreferredServerGroup(CollectionIdentifier collection,
 String id)

getReplicaFromPreferredServerGroupReactive

public reactor.core.publisher.Mono<CoreTransactionGetResult> getReplicaFromPreferredServerGroupReactive(CollectionIdentifier collection,
 String id)

getMultiAlgo

public List<CoreTransactionOptionalGetMultiResult> getMultiAlgo(List<CoreTransactionGetMultiSpec> specs,
 CoreGetMultiOptions options,
 boolean replicasFromPreferredServerGroup)

getMultiAlgoReactive

public reactor.core.publisher.Mono<List<CoreTransactionOptionalGetMultiResult>> getMultiAlgoReactive(List<CoreTransactionGetMultiSpec> specs,
 CoreGetMultiOptions options,
 boolean replicasFromPreferredServerGroup)

getMultiSingleDocumentFetch

public Either<CoreTransactionOptionalGetMultiResult,CoreGetMultiSignal> getMultiSingleDocumentFetch(CoreTransactionGetMultiSpec spec,
 CoreGetMultiState operationState)

getMultiDocumentFetch

public CoreGetMultiSignal getMultiDocumentFetch(CoreGetMultiState operationState)

atrId

public Optional<String> atrId()

atrCollection

public Optional<CollectionIdentifier> atrCollection()

insert

public CoreTransactionGetResult insert(CollectionIdentifier collection,
 String id,
 byte[] content,
 int flagsToStage,
 @Nullable
 CoreExpiry expiry,
 SpanWrapper pspan)

Inserts a new document into the specified Couchbase collection.

Parameters:

collection - the Couchbase collection in which to insert the doc

id - the document's unique ID

content - the content to insert

Returns:

the doc, updated with its new CAS value and ID, and converted to a TransactionGetResultInternal

insertReactive

public reactor.core.publisher.Mono<CoreTransactionGetResult> insertReactive(CollectionIdentifier collection,
 String id,
 byte[] content,
 int flagsToStage,
 @Nullable
 CoreExpiry expiry,
 SpanWrapper pspan)

insert

@UsedBy(SPRING_DATA_COUCHBASE)
@Deprecated
public reactor.core.publisher.Mono<CoreTransactionGetResult> insert(CollectionIdentifier collection,
 String id,
 byte[] content,
 SpanWrapper pspan)

Deprecated.

in favor of insert(CollectionIdentifier, String, byte[], int, CoreExpiry, SpanWrapper) which takes an additional 'flags' argument.

randomAtrIdForVbucket

protected String randomAtrIdForVbucket(CoreTransactionAttemptContext self,
 Integer vbucketIdForDoc,
 int numAtrs)

replace

public CoreTransactionGetResult replace(CoreTransactionGetResult doc,
 byte[] content,
 int flags,
 @Nullable
 CoreExpiry expiry,
 SpanWrapper pspan)

Mutates the specified doc with new content, using the document's last CoreTransactionGetResult.cas().

Parameters:

doc - the doc to be mutated

content - the content to replace the doc with

Returns:

the doc, updated with its new CAS value. For performance a copy is not created and the original doc object is modified.

replaceReactive

public reactor.core.publisher.Mono<CoreTransactionGetResult> replaceReactive(CoreTransactionGetResult doc,
 byte[] content,
 int flags,
 @Nullable
 CoreExpiry expiry,
 SpanWrapper pspan)

replace

@UsedBy(SPRING_DATA_COUCHBASE)
@Deprecated
public reactor.core.publisher.Mono<CoreTransactionGetResult> replace(CoreTransactionGetResult doc,
 byte[] content,
 SpanWrapper pspan)

Deprecated.

in favor of replace(CoreTransactionGetResult, byte[], int, CoreExpiry, SpanWrapper) which takes an additional 'flags' argument.

doQueryOperation

public <T> T doQueryOperation(String lockDebugIn,
 String statement,
 @Nullable
 CoreQueryOptions opts,
 @Nullable
 SpanWrapper pspan,
 BiFunction<Integer,SpanWrapper,T> op)

Doesn't need everything from doKVOperation, as queryWrapper already centralises a lot of logic

remove

public void remove(CoreTransactionGetResult doc,
 SpanWrapper pspan)

Removes the specified doc, using the document's last CoreTransactionGetResult.cas().

Parameters:

doc - - the doc to be removed

removeReactive

public reactor.core.publisher.Mono<Void> removeReactive(CoreTransactionGetResult doc,
 SpanWrapper pspan)

commit

public void commit()

Commits the transaction. All staged replaces, inserts and removals will be written.

span

public RequestSpan span()

rollback

public void rollback()

Rolls back the transaction. All staged replaces, inserts and removals will be removed. The transaction will not be retried, so this will be the final attempt.

operationFailed

public TransactionOperationFailedException operationFailed(boolean updateInternalState,
 TransactionOperationFailedException err)

Rollback errors rules: Errors during auto-rollback: do not update internal state, as the user cares more about the original error that provoked the rollback Errors during app-rollback: do update internal state. Nothing else has gone wrong with the transaction, and the user will care about rollback problems.

If !updateInternalState, the internal state bits are not changed.

operationFailed

public TransactionOperationFailedException operationFailed(TransactionOperationFailedException err)

queryWrapperLocked

public ClassicCoreReactiveQueryResult queryWrapperLocked(int sidx,
 @Nullable
 CoreQueryContext qc,
 String statement,
 @Nullable
 CoreQueryOptions options,
 String hookPoint,
 boolean isBeginWork,
 boolean existingErrorCheck,
 @Nullable
 com.couchbase.client.core.deps.com.fasterxml.jackson.databind.node.ObjectNode txdata,
 @Nullable
 com.couchbase.client.core.deps.com.fasterxml.jackson.databind.node.ArrayNode params,
 @Nullable
 SpanWrapper span,
 boolean tximplicit,
 boolean updateInternalState)

This will return a TransactionOperationFailedException if that's what query returns, else will return the error after passing through convertQueryError.

If an error is universally handled the same way, then convertQueryError will return a TransactionOperationFailedException.

Because this is a general-purpose wrapper, TransactionOperationFaileds will _not_ be added to internal errors array. So the transaction is allowed to continue after failures, unless the caller prevents it. Update: appears to no longer be the case.

Though the implementation is largely de-reactorised, this low-level function continues with ClassicCoreReactiveQueryResult as that supports streaming invalid input: '&' backpressure, which is needed for single query transactions.

queryBlocking

public CoreQueryResult queryBlocking(String statement,
 @Nullable
 CoreQueryContext qc,
 @Nullable
 CoreQueryOptions options,
 boolean tximplicit)

Used by AttemptContext, buffers all query rows in-memory.

queryReactive

public reactor.core.publisher.Mono<CoreQueryResult> queryReactive(String statement,
 @Nullable
 CoreQueryContext qc,
 @Nullable
 CoreQueryOptions options,
 boolean tximplicit)

logger

public CoreTransactionLogger logger()

Returns the CoreTransactionLogger used by this instance, so the developer can insert their own log messages.

toString

public String toString()

Overrides:

toString in class Object