Class CoreSession

Namespace

MongoDB.Driver.Core.Bindings

Assembly

MongoDB.Driver.Core.dll

Represents a session.

public sealed class CoreSession : ICoreSession, IDisposable

Inheritance

object

CoreSession

Implements

ICoreSession

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

CoreSession(ICluster, ICoreServerSession, CoreSessionOptions)

Initializes a new instance of the CoreSession class.

[Obsolete("This constructor is deprecated. Avoid using CoreSession directly.")]
public CoreSession(ICluster cluster, ICoreServerSession serverSession, CoreSessionOptions options)

Parameters

cluster ICluster

The cluster.

serverSession ICoreServerSession

The server session.

options CoreSessionOptions

The options.

See Also

ICoreSession

Properties

Cluster

Gets the cluster.

public ICluster Cluster { get; }

Property Value

ICluster

The cluster.

See Also

ICoreSession

ClusterTime

Gets the cluster time.

public BsonDocument ClusterTime { get; }

Property Value

BsonDocument

The cluster time.

See Also

ICoreSession

CurrentTransaction

Gets the current transaction.

public CoreTransaction CurrentTransaction { get; }

Property Value

CoreTransaction

The current transaction.

See Also

ICoreSession

Id

Gets the session Id.

public BsonDocument Id { get; }

Property Value

BsonDocument

The session Id.

See Also

ICoreSession

IsCausallyConsistent

Gets a value indicate whether this instance is causally consistent.

public bool IsCausallyConsistent { get; }

Property Value

bool

true if the session is causally consistent.

See Also

ICoreSession

IsDirty

Gets a value indicate whether this session is dirty.

public bool IsDirty { get; }

Property Value

bool

true if the session is dirty.

See Also

ICoreSession

IsImplicit

Gets a value indicating whether this instance is implicit session.

public bool IsImplicit { get; }

Property Value

bool

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

See Also

ICoreSession

IsInTransaction

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

public bool IsInTransaction { get; }

Property Value

bool

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

See Also

ICoreSession

IsSnapshot

Gets a value indicate whether this instance is a snapshot session.

public bool IsSnapshot { get; }

Property Value

bool

true if the session is a snapshot session.

See Also

ICoreSession

OperationTime

Gets the operation time.

public BsonTimestamp OperationTime { get; }

Property Value

BsonTimestamp

The operation time.

See Also

ICoreSession

Options

Gets the session options.

public CoreSessionOptions Options { get; }

Property Value

CoreSessionOptions

The session options.

See Also

ICoreSession

ServerSession

Gets the server session.

public ICoreServerSession ServerSession { get; }

Property Value

ICoreServerSession

The server session.

See Also

ICoreSession

SnapshotTime

Gets the snapshot time.

public BsonTimestamp SnapshotTime { get; }

Property Value

BsonTimestamp

The snapshot time.

See Also

ICoreSession

Methods

AbortTransaction(CancellationToken)

Aborts the transaction.

public void AbortTransaction(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

The cancellation token.

See Also

ICoreSession

AbortTransactionAsync(CancellationToken)

Aborts the transaction.

public Task AbortTransactionAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

The cancellation token.

Returns

Task

A Task.

See Also

ICoreSession

AboutToSendCommand()

The driver is about to send a command on this session. Called to track session state.

public void AboutToSendCommand()

See Also

ICoreSession

AdvanceClusterTime(BsonDocument)

Advances the cluster time.

public void AdvanceClusterTime(BsonDocument newClusterTime)

Parameters

newClusterTime BsonDocument

The new cluster time.

See Also

ICoreSession

AdvanceOperationTime(BsonTimestamp)

Advances the operation time.

public void AdvanceOperationTime(BsonTimestamp newOperationTime)

Parameters

newOperationTime BsonTimestamp

The new operation time.

See Also

ICoreSession

AdvanceTransactionNumber()

Advances the transaction id.

public long AdvanceTransactionNumber()

Returns

long

The transaction id.

See Also

ICoreSession

CommitTransaction(CancellationToken)

Commits the transaction.

public void CommitTransaction(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

The cancellation token.

See Also

ICoreSession

CommitTransactionAsync(CancellationToken)

Commits the transaction.

public Task CommitTransactionAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

The cancellation token.

Returns

Task

A Task.

See Also

ICoreSession

Dispose()

public void Dispose()

See Also

ICoreSession

MarkDirty()

Marks the session as dirty.

public void MarkDirty()

See Also

ICoreSession

SetSnapshotTimeIfNeeded(BsonTimestamp)

Sets the snapshot time if not set.

public void SetSnapshotTimeIfNeeded(BsonTimestamp snapshotTime)

Parameters

snapshotTime BsonTimestamp

The snapshot time.

See Also

ICoreSession

StartTransaction(TransactionOptions)

Starts a transaction.

public void StartTransaction(TransactionOptions transactionOptions = null)

Parameters

transactionOptions TransactionOptions

The transaction options.

See Also

ICoreSession

WasUsed()

Called by the driver when the session is used (i.e. sent to the server).

public void WasUsed()

See Also

ICoreSession

See Also

ICoreSession