Class CommandOperationBase<TCommandResult>

Namespace

MongoDB.Driver.Core.Operations

Assembly

MongoDB.Driver.Core.dll

Represents the base class for a command operation.

public abstract class CommandOperationBase<TCommandResult>

Type Parameters

TCommandResult

The type of the command result.

Inheritance

object

CommandOperationBase<TCommandResult>

Derived

ReadCommandOperation<TCommandResult>

WriteCommandOperation<TCommandResult>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

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

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

protected CommandOperationBase(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

AdditionalOptions

Gets or sets the additional options.

public BsonDocument AdditionalOptions { get; set; }

Property Value

BsonDocument

The additional options.

Command

Gets the command.

public BsonDocument Command { get; }

Property Value

BsonDocument

The command.

CommandValidator

Gets or sets the command validator.

public IElementNameValidator CommandValidator { get; set; }

Property Value

IElementNameValidator

The command validator.

Comment

Gets or sets the comment.

public string Comment { get; set; }

Property Value

string

The comment.

DatabaseNamespace

Gets the database namespace.

public DatabaseNamespace DatabaseNamespace { get; }

Property Value

DatabaseNamespace

The database namespace.

MessageEncoderSettings

Gets the message encoder settings.

public MessageEncoderSettings MessageEncoderSettings { get; }

Property Value

MessageEncoderSettings

The message encoder settings.

ResultSerializer

Gets the result serializer.

public IBsonSerializer<TCommandResult> ResultSerializer { get; }

Property Value

IBsonSerializer<TCommandResult>

The result serializer.

Methods

ExecuteProtocol(IChannelHandle, ICoreSessionHandle, ReadPreference, CancellationToken)

Executes the protocol.

protected TCommandResult ExecuteProtocol(IChannelHandle channel, ICoreSessionHandle session, ReadPreference readPreference, CancellationToken cancellationToken)

Parameters

channel IChannelHandle

The channel.

session ICoreSessionHandle

The session.

readPreference ReadPreference

The read preference.

cancellationToken CancellationToken

The cancellation token.

Returns

TCommandResult

A Task whose result is the command result.

ExecuteProtocol(IChannelSource, ICoreSessionHandle, ReadPreference, CancellationToken)

Executes the protocol.

protected TCommandResult ExecuteProtocol(IChannelSource channelSource, ICoreSessionHandle session, ReadPreference readPreference, CancellationToken cancellationToken)

Parameters

channelSource IChannelSource

The channel source.

session ICoreSessionHandle

The session.

readPreference ReadPreference

The read preference.

cancellationToken CancellationToken

The cancellation token.

Returns

TCommandResult

A Task whose result is the command result.

ExecuteProtocolAsync(IChannelHandle, ICoreSessionHandle, ReadPreference, CancellationToken)

Executes the protocol.

protected Task<TCommandResult> ExecuteProtocolAsync(IChannelHandle channel, ICoreSessionHandle session, ReadPreference readPreference, CancellationToken cancellationToken)

Parameters

channel IChannelHandle

The channel.

session ICoreSessionHandle

The session.

readPreference ReadPreference

The read preference.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<TCommandResult>

A Task whose result is the command result.

ExecuteProtocolAsync(IChannelSource, ICoreSessionHandle, ReadPreference, CancellationToken)

Executes the protocol.

protected Task<TCommandResult> ExecuteProtocolAsync(IChannelSource channelSource, ICoreSessionHandle session, ReadPreference readPreference, CancellationToken cancellationToken)

Parameters

channelSource IChannelSource

The channel source.

session ICoreSessionHandle

The session.

readPreference ReadPreference

The read preference.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<TCommandResult>

A Task whose result is the command result.