mongo4cats-kernel/mongo4cats.client/ClientSession

ClientSession

abstract class ClientSession[F[_]]
class Object
trait Matchable
class Any

Value members

Abstract methods

def abortTransaction: F[Unit]

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

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

def commitTransaction: F[Unit]

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

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

def startTransaction(options: TransactionOptions): F[Unit]

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.

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.

Value parameters:
options

the options to apply to the transaction

def underlying: ClientSession

Concrete methods

def hasActiveTransaction: Boolean

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, and false otherwise

Returns:

true if there is an active transaction on this session

def startTransaction: F[Unit]
def transactionOptions: Option[TransactionOptions]

Gets the transaction options. If session has no active transaction, then None is returned

Gets the transaction options. If session has no active transaction, then None is returned

Returns:

the transaction options