fluid-mongo/io.fluidsonic.mongo/ClientSession

ClientSession

interface ClientSession : ClientSession
Content copied to clipboard

A client session that supports transactions.

Since

3.8

Types

Link copied to clipboard
object Companion
Content copied to clipboard

Functions

Link copied to clipboard
abstract suspend fun abortTransaction()
Content copied to clipboard

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

Link copied to clipboard
abstract fun advanceClusterTime(p0: BsonDocument)
Content copied to clipboard
Link copied to clipboard
abstract fun advanceOperationTime(p0: BsonTimestamp)
Content copied to clipboard
Link copied to clipboard
abstract fun clearTransactionContext()
Content copied to clipboard
Link copied to clipboard
abstract override fun close()
Content copied to clipboard
Link copied to clipboard
abstract suspend fun commitTransaction()
Content copied to clipboard

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

Link copied to clipboard
abstract fun getClusterTime(): BsonDocument
Content copied to clipboard
Link copied to clipboard
abstract fun getOperationTime(): BsonTimestamp
Content copied to clipboard
Link copied to clipboard
abstract fun getOptions(): ClientSessionOptions
Content copied to clipboard
Link copied to clipboard
abstract fun getOriginator(): Any
Content copied to clipboard
Link copied to clipboard
@Nullable
abstract fun getPinnedServerAddress(): ServerAddress
Content copied to clipboard
Link copied to clipboard
@Nullable
abstract fun getRecoveryToken(): BsonDocument
Content copied to clipboard
Link copied to clipboard
abstract fun getServerSession(): ServerSession
Content copied to clipboard
Link copied to clipboard
@Nullable
abstract fun getSnapshotTimestamp(): BsonTimestamp
Content copied to clipboard
Link copied to clipboard
@Nullable
abstract fun getTransactionContext(): Any
Content copied to clipboard
Link copied to clipboard
abstract fun hasActiveTransaction(): Boolean
Content copied to clipboard

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

Link copied to clipboard
abstract fun isCausallyConsistent(): Boolean
Content copied to clipboard
Link copied to clipboard
abstract fun setRecoveryToken(p0: BsonDocument)
Content copied to clipboard
Link copied to clipboard
abstract fun setSnapshotTimestamp(p0: BsonTimestamp)
Content copied to clipboard
Link copied to clipboard
abstract fun setTransactionContext(p0: ServerAddress, p1: Any)
Content copied to clipboard
Link copied to clipboard
abstract fun startTransaction()
Content copied to clipboard

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.

abstract fun startTransaction(transactionOptions: TransactionOptions)
Content copied to clipboard

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

Link copied to clipboard
abstract val transactionOptions: TransactionOptions?
Content copied to clipboard

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