ReadCommandOperationTCommandResult Class

Represents a read command operation.

Inheritance Hierarchy

SystemObject
MongoDB.Driver.Core.OperationsCommandOperationBaseTCommandResult
MongoDB.Driver.Core.OperationsReadCommandOperationTCommandResult

Namespace: MongoDB.Driver.Core.Operations
Assembly: MongoDB.Driver.Core (in MongoDB.Driver.Core.dll) Version: 2.19.1+3a2a09dd959482f665ffbb5df2557ec541597af4

Syntax

Copy

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

Public Class ReadCommandOperation(Of TCommandResult)
	Inherits CommandOperationBase(Of TCommandResult)
	Implements IReadOperation(Of TCommandResult), IRetryableReadOperation(Of TCommandResult), 
	IExecutableInRetryableReadContext(Of TCommandResult)

type ReadCommandOperation<'TCommandResult> =  
    class
        inherit CommandOperationBase<'TCommandResult>
        interface IReadOperation<'TCommandResult>
        interface IRetryableReadOperation<'TCommandResult>
        interface IExecutableInRetryableReadContext<'TCommandResult>
    end

Type Parameters

TCommandResult: The type of the command result.

The ReadCommandOperationTCommandResult type exposes the following members.

Constructors

	Name	Description
	ReadCommandOperationTCommandResult	Initializes a new instance of the ReadCommandOperationTCommandResult class.

Top

Properties

	Name	Description
	AdditionalOptions	Gets or sets the additional options. (Inherited from CommandOperationBaseTCommandResult.)
	Command	Gets the command. (Inherited from CommandOperationBaseTCommandResult.)
	CommandValidator	Gets or sets the command validator. (Inherited from CommandOperationBaseTCommandResult.)
	Comment	Gets or sets the comment. (Inherited from CommandOperationBaseTCommandResult.)
	DatabaseNamespace	Gets the database namespace. (Inherited from CommandOperationBaseTCommandResult.)
	MessageEncoderSettings	Gets the message encoder settings. (Inherited from CommandOperationBaseTCommandResult.)
	ResultSerializer	Gets the result serializer. (Inherited from CommandOperationBaseTCommandResult.)
	RetryRequested	Gets or sets a value indicating whether to retry.

Top

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Execute(IReadBinding, CancellationToken)	Executes the operation.
	Execute(RetryableReadContext, CancellationToken)	Executes the first attempt.
	ExecuteAsync(IReadBinding, CancellationToken)	Executes the operation.
	ExecuteAsync(RetryableReadContext, CancellationToken)	Executes the first attempt.
	ExecuteAttempt	Executes the first attempt.
	ExecuteAttemptAsync	Executes the first attempt.
	ExecuteProtocol(IChannelHandle, ICoreSessionHandle, ReadPreference, CancellationToken)	Executes the protocol. (Inherited from CommandOperationBaseTCommandResult.)
	ExecuteProtocol(IChannelSource, ICoreSessionHandle, ReadPreference, CancellationToken)	Executes the protocol. (Inherited from CommandOperationBaseTCommandResult.)
	ExecuteProtocolAsync(IChannelHandle, ICoreSessionHandle, ReadPreference, CancellationToken)	Executes the protocol. (Inherited from CommandOperationBaseTCommandResult.)
	ExecuteProtocolAsync(IChannelSource, ICoreSessionHandle, ReadPreference, CancellationToken)	Executes the protocol. (Inherited from CommandOperationBaseTCommandResult.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Extension Methods

	Name	Description
	ExecuteTCommandResult	Executes a read operation using a channel source. (Defined by OperationExtensionMethods.)
	ExecuteAsyncTCommandResult	Executes a read operation using a channel source. (Defined by OperationExtensionMethods.)
	ToBson	Serializes an object to a BSON byte array. (Defined by BsonExtensionMethods.)
	ToBsonDocument	Serializes an object to a BsonDocument. (Defined by BsonExtensionMethods.)
	ToJson	Serializes an object to a JSON string. (Defined by BsonExtensionMethods.)

Top

Reference

MongoDB.Driver.Core.Operations Namespace

ReadCommandOperationAddLanguageSpecificTextSet("LSTC526DC44_0?cs=&lt;|vb=(Of |cpp=&lt;|fs=&lt;'|nu=(");TCommandResultAddLanguageSpecificTextSet("LSTC526DC44_1?cs=&gt;|vb=)|cpp=&gt;|fs=&gt;|nu=)"); Class

Type Parameters

Reference

ReadCommandOperationTCommandResult Class