FindOperationTDocument Class |
Represents a Find operation.
Inheritance HierarchyNamespace: MongoDB.Driver.Core.Operations
Assembly: MongoDB.Driver.Core (in MongoDB.Driver.Core.dll) Version: 2.9.0+32b058abcdf2c7e8d9dd3a676d207b31897eee2e
Syntaxpublic class FindOperation<TDocument> : IReadOperation<IAsyncCursor<TDocument>>, IExecutableInRetryableReadContext<IAsyncCursor<TDocument>>
Type Parameters
- TDocument
- The type of the returned documents.
The FindOperationTDocument type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | FindOperationTDocument |
Initializes a new instance of the FindOperationTDocument class.
|
Properties| Name | Description | |
|---|---|---|
 | 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.
|
| 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 |
Gets or sets any additional query modifiers.
|
| NoCursorTimeout |
Gets or sets a value indicating whether the server will not timeout the cursor.
|
| OplogReplay |
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 whether or not retry was requested.
|
| 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.
|
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.
|
 | 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.) |
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.) |
See Also