FindOperationTDocument Class

Represents a Find command operation.

Inheritance Hierarchy

SystemObject
MongoDB.Driver.Core.OperationsFindOperationTDocument

Namespace: MongoDB.Driver.Core.Operations
Assembly: MongoDB.Driver.Core (in MongoDB.Driver.Core.dll) Version: 2.21.0+5a9c3311e158910b88195f290e6d4b1b2715d2b2

Syntax

Copy

public class FindOperation<TDocument> : IReadOperation<IAsyncCursor<TDocument>>, 
	IExecutableInRetryableReadContext<IAsyncCursor<TDocument>>, IExplainableOperation

Public Class FindOperation(Of TDocument)
	Implements IReadOperation(Of IAsyncCursor(Of TDocument)), 
	IExecutableInRetryableReadContext(Of IAsyncCursor(Of TDocument)), IExplainableOperation

type FindOperation<'TDocument> =  
    class
        interface IReadOperation<IAsyncCursor<'TDocument>>
        interface IExecutableInRetryableReadContext<IAsyncCursor<'TDocument>>
        interface IExplainableOperation
    end

Type Parameters

TDocument: The type of the document.

The FindOperationTDocument type exposes the following members.

Constructors

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

Top

Properties

	Name	Description
	AllowDiskUse	Gets or sets a value indicating whether the server is allowed to write to disk while executing the Find operation.
	AllowPartialResults	Gets or sets a value indicating whether the server is allowed to return partial results if any shards are unavailable.
	BatchSize	Gets or sets the size of a batch.
	Collation	Gets or sets the collation.
	CollectionNamespace	Gets the collection namespace.
	Comment	Gets or sets the comment.
	CursorType	Gets or sets the type of the cursor.
	Filter	Gets or sets the filter.
	FirstBatchSize	Gets or sets the size of the first batch.
	Hint	Gets or sets the hint.
	Let	Gets or sets the let document.
	Limit	Gets or sets the limit.
	Max	Gets or sets the max key value.
	MaxAwaitTime	Gets or sets the maximum await time for TailableAwait cursors.
	MaxScan	Obsolete. Gets or sets the max scan.
	MaxTime	Gets or sets the maximum time the server should spend on this operation.
	MessageEncoderSettings	Gets the message encoder settings.
	Min	Gets or sets the min key value.
	Modifiers	Obsolete. Gets or sets any additional query modifiers.
	NoCursorTimeout	Gets or sets a value indicating whether the server will not timeout the cursor.
	OplogReplay	Obsolete. Gets or sets a value indicating whether the OplogReplay bit will be set.
	Projection	Gets or sets the projection.
	ReadConcern	Gets or sets the read concern.
	ResultSerializer	Gets the result serializer.
	RetryRequested	Gets or sets a value indicating whether to retry.
	ReturnKey	Gets or sets whether to only return the key values.
	ShowRecordId	Gets or sets whether the record Id should be added to the result document.
	SingleBatch	Gets or sets whether to return only a single batch.
	Skip	Gets or sets the number of documents skip.
	Snapshot	Obsolete. Gets or sets whether to use snapshot behavior.
	Sort	Gets or sets the sort specification.

Top

Methods

	Name	Description
	CreateCommand	Creates the command to be explained.
	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.
	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
	ExecuteIAsyncCursorTDocument	Executes a read operation using a channel source. (Defined by OperationExtensionMethods.)
	ExecuteAsyncIAsyncCursorTDocument	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

FindOperationAddLanguageSpecificTextSet("LSTB8486BBC_0?cs=&lt;|vb=(Of |cpp=&lt;|fs=&lt;'|nu=(");TDocumentAddLanguageSpecificTextSet("LSTB8486BBC_1?cs=&gt;|vb=)|cpp=&gt;|fs=&gt;|nu=)"); Class

Type Parameters

Reference

FindOperationTDocument Class