com.mongodb.reactivestreams.client

Interface ClientSession

All Superinterfaces:

AutoCloseable, ClientSession, Closeable

public interface ClientSession
extends ClientSession

A client session that supports transactions.

Since:

1.9

Method Summary

Modifier and Type	Method and Description
org.reactivestreams.Publisher<Void>	abortTransaction() Abort a transaction in the context of this session.
org.reactivestreams.Publisher<Void>	commitTransaction() Commit a transaction in the context of this session.
TransactionOptions	getTransactionOptions() Gets the transaction options.
ClientSession	getWrapped() For internal use only.
boolean	hasActiveTransaction() Returns true if there is an active transaction on this session, and false otherwise
void	startTransaction() Start a transaction in the context of this session with default transaction options.
void	startTransaction(TransactionOptions transactionOptions) Start a transaction in the context of this session with the given transaction options.

Methods inherited from interface com.mongodb.session.ClientSession

advanceClusterTime, advanceOperationTime, close, getClusterTime, getOperationTime, getOptions, getOriginator, getServerSession, isCausallyConsistent

Method Detail

hasActiveTransaction

boolean hasActiveTransaction()

Returns true if there is an active transaction on this session, and false otherwise

Returns:

true if there is an active transaction on this session

Since server release

4.0

getTransactionOptions

TransactionOptions getTransactionOptions()

Gets the transaction options. Only call this method of the session has an active transaction

Returns:

the transaction options

getWrapped

ClientSession getWrapped()

For internal use only.

Returns:

the wrapped session

startTransaction

void startTransaction()

Start a transaction in the context of this session with default transaction options. A transaction can not be started if there is already an active transaction on this session.

Since server release

4.0

startTransaction

void startTransaction(TransactionOptions transactionOptions)

Start a transaction in the context of this session with the given transaction options. A transaction can not be started if there is already an active transaction on this session.

Parameters:

transactionOptions - the options to apply to the transaction

Since server release

4.0

commitTransaction

org.reactivestreams.Publisher<Void> commitTransaction()

Commit a transaction in the context of this session. A transaction can only be commmited if one has first been started.

Returns:

a publisher with a single element indicating when the operation has completed

Since server release

4.0

abortTransaction

org.reactivestreams.Publisher<Void> abortTransaction()

Abort a transaction in the context of this session. A transaction can only be aborted if one has first been started.

Returns:

a publisher with a single element indicating when the operation has completed

Since server release

4.0