Class WriteCommandOperation<TCommandResult>

Namespace

MongoDB.Driver.Core.Operations

Assembly

MongoDB.Driver.Core.dll

Represents a write command operation.

public class WriteCommandOperation<TCommandResult> : CommandOperationBase<TCommandResult>, IWriteOperation<TCommandResult>

Type Parameters

TCommandResult

The type of the command result.

Inheritance

object

CommandOperationBase<TCommandResult>

WriteCommandOperation<TCommandResult>

Implements

IWriteOperation<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>(IWriteOperation<TResult>, IChannelSourceHandle, ICoreSessionHandle, CancellationToken)

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

Constructors

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

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

public WriteCommandOperation(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

ReadPreference

Gets or sets the read preference.

public ReadPreference ReadPreference { get; set; }

Property Value

ReadPreference

Methods

Execute(IWriteBinding, CancellationToken)

Executes the operation.

public TCommandResult Execute(IWriteBinding binding, CancellationToken cancellationToken)

Parameters

binding IWriteBinding

The binding.

cancellationToken CancellationToken

The cancellation token.

Returns

TCommandResult

The result of the operation.

ExecuteAsync(IWriteBinding, CancellationToken)

Executes the operation.

public Task<TCommandResult> ExecuteAsync(IWriteBinding binding, CancellationToken cancellationToken = default)

Parameters

binding IWriteBinding

The binding.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<TCommandResult>

A Task whose result is the result of the operation.