Class ReadCommandOperation<TCommandResult>

Namespace

MongoDB.Driver.Core.Operations

Assembly

MongoDB.Driver.Core.dll

Represents a read command operation.

public class ReadCommandOperation<TCommandResult> : CommandOperationBase<TCommandResult>, IReadOperation<TCommandResult>, IRetryableReadOperation<TCommandResult>, IExecutableInRetryableReadContext<TCommandResult>

Type Parameters

TCommandResult

The type of the command result.

Inheritance

object

CommandOperationBase<TCommandResult>

ReadCommandOperation<TCommandResult>

Implements

IReadOperation<TCommandResult>

IRetryableReadOperation<TCommandResult>

IExecutableInRetryableReadContext<TCommandResult>

Inherited Members

CommandOperationBase<TCommandResult>.AdditionalOptions

CommandOperationBase<TCommandResult>.Command

CommandOperationBase<TCommandResult>.CommandValidator

CommandOperationBase<TCommandResult>.Comment

CommandOperationBase<TCommandResult>.DatabaseNamespace

CommandOperationBase<TCommandResult>.MessageEncoderSettings

CommandOperationBase<TCommandResult>.ResultSerializer

CommandOperationBase<TCommandResult>.ExecuteProtocol(IChannelHandle, ICoreSessionHandle, ReadPreference, CancellationToken)

CommandOperationBase<TCommandResult>.ExecuteProtocol(IChannelSource, ICoreSessionHandle, ReadPreference, CancellationToken)

CommandOperationBase<TCommandResult>.ExecuteProtocolAsync(IChannelHandle, ICoreSessionHandle, ReadPreference, CancellationToken)

CommandOperationBase<TCommandResult>.ExecuteProtocolAsync(IChannelSource, ICoreSessionHandle, ReadPreference, CancellationToken)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

OperationExtensionMethods.ExecuteAsync<TResult>(IReadOperation<TResult>, IChannelSourceHandle, ReadPreference, ICoreSessionHandle, CancellationToken)

OperationExtensionMethods.Execute<TResult>(IReadOperation<TResult>, IChannelSourceHandle, ReadPreference, ICoreSessionHandle, CancellationToken)

Constructors

ReadCommandOperation(DatabaseNamespace, BsonDocument, IBsonSerializer<TCommandResult>, MessageEncoderSettings)

Initializes a new instance of the ReadCommandOperation<TCommandResult> class.

public ReadCommandOperation(DatabaseNamespace databaseNamespace, BsonDocument command, IBsonSerializer<TCommandResult> resultSerializer, MessageEncoderSettings messageEncoderSettings)

Parameters

databaseNamespace DatabaseNamespace

The database namespace.

command BsonDocument

The command.

resultSerializer IBsonSerializer<TCommandResult>

The result serializer.

messageEncoderSettings MessageEncoderSettings

The message encoder settings.

Properties

RetryRequested

Gets or sets a value indicating whether to retry.

public bool RetryRequested { get; set; }

Property Value

bool

Whether to retry.

Methods

Execute(IReadBinding, CancellationToken)

Executes the operation.

public TCommandResult Execute(IReadBinding binding, CancellationToken cancellationToken)

Parameters

binding IReadBinding

The binding.

cancellationToken CancellationToken

The cancellation token.

Returns

TCommandResult

The result of the operation.

Execute(RetryableReadContext, CancellationToken)

Executes the first attempt.

public TCommandResult Execute(RetryableReadContext context, CancellationToken cancellationToken)

Parameters

context RetryableReadContext

The context.

cancellationToken CancellationToken

The cancellation token.

Returns

TCommandResult

The result.

ExecuteAsync(IReadBinding, CancellationToken)

Executes the operation.

public Task<TCommandResult> ExecuteAsync(IReadBinding binding, CancellationToken cancellationToken)

Parameters

binding IReadBinding

The binding.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<TCommandResult>

A Task whose result is the result of the operation.

ExecuteAsync(RetryableReadContext, CancellationToken)

Executes the first attempt.

public Task<TCommandResult> ExecuteAsync(RetryableReadContext context, CancellationToken cancellationToken)

Parameters

context RetryableReadContext

The context.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<TCommandResult>

The result.

ExecuteAttempt(RetryableReadContext, int, long?, CancellationToken)

Executes the first attempt.

public TCommandResult ExecuteAttempt(RetryableReadContext context, int attempt, long? transactionNumber, CancellationToken cancellationToken)

Parameters

context RetryableReadContext

The context.

attempt int

The attempt.

transactionNumber long?

The transaction number.

cancellationToken CancellationToken

The cancellation token.

Returns

TCommandResult

The result.

ExecuteAttemptAsync(RetryableReadContext, int, long?, CancellationToken)

Executes the first attempt.

public Task<TCommandResult> ExecuteAttemptAsync(RetryableReadContext context, int attempt, long? transactionNumber, CancellationToken cancellationToken)

Parameters

context RetryableReadContext

The context.

attempt int

The attempt.

transactionNumber long?

The transaction number.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<TCommandResult>

The result.