mongodb-driver-kotlin-coroutine/com.mongodb.kotlin.client.coroutine/ClientSession

ClientSession

class ClientSession(val wrapped: ClientSession) : ClientSession

A client session that supports transactions.

Constructors

constructor(wrapped: ClientSession)

Functions

abortTransaction

suspend fun abortTransaction()

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

advanceClusterTime

open override fun advanceClusterTime(clusterTime: BsonDocument?)

advanceOperationTime

open override fun advanceOperationTime(operationTime: BsonTimestamp?)

Set the operation time of the last operation executed in this session.

clearTransactionContext

open override fun clearTransactionContext()

Clears the transaction context.

open override fun close()

commitTransaction

suspend fun commitTransaction()

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

open override fun getClusterTime(): BsonDocument

getOperationTime

open override fun getOperationTime(): BsonTimestamp

Gets the operation time of the last operation executed in this session.

open override fun getOptions(): ClientSessionOptions

Get the options for this session.

open override fun getOriginator(): Any

Gets the originator for the session.

getPinnedServerAddress

open override fun getPinnedServerAddress(): ServerAddress?

Get the server address of the pinned mongos on this session. For internal use only.

getRecoveryToken

open override fun getRecoveryToken(): BsonDocument?

Get the recovery token from the latest outcome in a sharded transaction. For internal use only.

getServerSession

open override fun getServerSession(): ServerSession

getSnapshotTimestamp

open override fun getSnapshotTimestamp(): BsonTimestamp?

For internal use only.

getTransactionContext

open override fun getTransactionContext(): Any?

Gets the transaction context.

getTransactionOptions

fun getTransactionOptions(): TransactionOptions

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

hasActiveTransaction

fun hasActiveTransaction(): Boolean

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

isCausallyConsistent

open override fun isCausallyConsistent(): Boolean

Returns true if operations in this session must be causally consistent

notifyMessageSent

fun notifyMessageSent(): Boolean

Notify the client session that a message has been sent.

notifyOperationInitiated

fun notifyOperationInitiated(operation: Any)

Notify the client session that command execution is being initiated. This should be called before server selection occurs.

setRecoveryToken

open override fun setRecoveryToken(recoveryToken: BsonDocument)

Set the recovery token. For internal use only.

setSnapshotTimestamp

open override fun setSnapshotTimestamp(snapshotTimestamp: BsonTimestamp?)

For internal use only.

setTransactionContext

open override fun setTransactionContext(address: ServerAddress, transactionContext: Any)

Sets the transaction context.

startTransaction

fun 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.

fun 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.

Properties

val wrapped: ClientSession