Interface IClientSession

Namespace

MongoDB.Driver

Assembly

MongoDB.Driver.dll

The interface for a client session.

public interface IClientSession : IDisposable

Inherited Members

IDisposable.Dispose()

Properties

Client

Gets the client.

IMongoClient Client { get; }

Property Value

IMongoClient

The client.

ClusterTime

Gets the cluster time.

BsonDocument ClusterTime { get; }

Property Value

BsonDocument

The cluster time.

IsImplicit

Gets a value indicating whether this session is an implicit session.

bool IsImplicit { get; }

Property Value

bool

true if this session is an implicit session; otherwise, false.

IsInTransaction

Gets a value indicating whether this instance is in a transaction.

bool IsInTransaction { get; }

Property Value

bool

true if this instance is in a transaction; otherwise, false.

OperationTime

Gets the operation time.

BsonTimestamp OperationTime { get; }

Property Value

BsonTimestamp

The operation time.

Options

Gets the options.

ClientSessionOptions Options { get; }

Property Value

ClientSessionOptions

The options.

ServerSession

Gets the server session.

IServerSession ServerSession { get; }

Property Value

IServerSession

The server session.

WrappedCoreSession

Gets the wrapped core session (intended for internal use only).

ICoreSessionHandle WrappedCoreSession { get; }

Property Value

ICoreSessionHandle

The wrapped core session.

Methods

AbortTransaction(CancellationToken)

Aborts the transaction.

void AbortTransaction(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

The cancellation token.

AbortTransactionAsync(CancellationToken)

Aborts the transaction.

Task AbortTransactionAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

The cancellation token.

Returns

Task

A Task.

AdvanceClusterTime(BsonDocument)

Advances the cluster time.

void AdvanceClusterTime(BsonDocument newClusterTime)

Parameters

newClusterTime BsonDocument

The new cluster time.

AdvanceOperationTime(BsonTimestamp)

Advances the operation time.

void AdvanceOperationTime(BsonTimestamp newOperationTime)

Parameters

newOperationTime BsonTimestamp

The new operation time.

CommitTransaction(CancellationToken)

Commits the transaction.

void CommitTransaction(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

The cancellation token.

CommitTransactionAsync(CancellationToken)

Commits the transaction.

Task CommitTransactionAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

The cancellation token.

Returns

Task

A Task.

StartTransaction(TransactionOptions)

Starts a transaction.

void StartTransaction(TransactionOptions transactionOptions = null)

Parameters

transactionOptions TransactionOptions

The transaction options.

WithTransactionAsync<TResult>(Func<IClientSessionHandle, CancellationToken, Task<TResult>>, TransactionOptions, CancellationToken)

Executes a callback within a transaction, with retries if needed.

Task<TResult> WithTransactionAsync<TResult>(Func<IClientSessionHandle, CancellationToken, Task<TResult>> callbackAsync, TransactionOptions transactionOptions = null, CancellationToken cancellationToken = default)

Parameters

callbackAsync Func<IClientSessionHandle, CancellationToken, Task<TResult>>

The user defined callback.

transactionOptions TransactionOptions

The transaction options.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<TResult>

The callback result.

Type Parameters

TResult

The type of callback result.

WithTransaction<TResult>(Func<IClientSessionHandle, CancellationToken, TResult>, TransactionOptions, CancellationToken)

Executes a callback within a transaction, with retries if needed.

TResult WithTransaction<TResult>(Func<IClientSessionHandle, CancellationToken, TResult> callback, TransactionOptions transactionOptions = null, CancellationToken cancellationToken = default)

Parameters

callback Func<IClientSessionHandle, CancellationToken, TResult>

The user defined callback.

transactionOptions TransactionOptions

The transaction options.

cancellationToken CancellationToken

The cancellation token.

Returns

TResult

The callback result.

Type Parameters

TResult

The type of callback result.