Class FindFluentBase<TDocument, TProjection>

Namespace

MongoDB.Driver

Assembly

MongoDB.Driver.dll

Base class for implementors of IFindFluent<TDocument, TProjection>.

public abstract class FindFluentBase<TDocument, TProjection> : IOrderedFindFluent<TDocument, TProjection>, IFindFluent<TDocument, TProjection>, IAsyncCursorSource<TProjection>

Type Parameters

TDocument

The type of the document.

TProjection

The type of the projection (same as TDocument if there is no projection).

Inheritance

object

FindFluentBase<TDocument, TProjection>

Implements

IOrderedFindFluent<TDocument, TProjection>

IFindFluent<TDocument, TProjection>

IAsyncCursorSource<TProjection>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

IAsyncCursorSourceExtensions.AnyAsync<TDocument>(IAsyncCursorSource<TDocument>, CancellationToken)

IAsyncCursorSourceExtensions.Any<TDocument>(IAsyncCursorSource<TDocument>, CancellationToken)

IAsyncCursorSourceExtensions.FirstAsync<TDocument>(IAsyncCursorSource<TDocument>, CancellationToken)

IAsyncCursorSourceExtensions.FirstOrDefaultAsync<TDocument>(IAsyncCursorSource<TDocument>, CancellationToken)

IAsyncCursorSourceExtensions.FirstOrDefault<TDocument>(IAsyncCursorSource<TDocument>, CancellationToken)

IAsyncCursorSourceExtensions.First<TDocument>(IAsyncCursorSource<TDocument>, CancellationToken)

IAsyncCursorSourceExtensions.ForEachAsync<TDocument>(IAsyncCursorSource<TDocument>, Action<TDocument, int>, CancellationToken)

IAsyncCursorSourceExtensions.ForEachAsync<TDocument>(IAsyncCursorSource<TDocument>, Action<TDocument>, CancellationToken)

IAsyncCursorSourceExtensions.ForEachAsync<TDocument>(IAsyncCursorSource<TDocument>, Func<TDocument, int, Task>, CancellationToken)

IAsyncCursorSourceExtensions.ForEachAsync<TDocument>(IAsyncCursorSource<TDocument>, Func<TDocument, Task>, CancellationToken)

IAsyncCursorSourceExtensions.SingleAsync<TDocument>(IAsyncCursorSource<TDocument>, CancellationToken)

IAsyncCursorSourceExtensions.SingleOrDefaultAsync<TDocument>(IAsyncCursorSource<TDocument>, CancellationToken)

IAsyncCursorSourceExtensions.SingleOrDefault<TDocument>(IAsyncCursorSource<TDocument>, CancellationToken)

IAsyncCursorSourceExtensions.Single<TDocument>(IAsyncCursorSource<TDocument>, CancellationToken)

IAsyncCursorSourceExtensions.ToEnumerable<TDocument>(IAsyncCursorSource<TDocument>, CancellationToken)

IAsyncCursorSourceExtensions.ToListAsync<TDocument>(IAsyncCursorSource<TDocument>, CancellationToken)

IAsyncCursorSourceExtensions.ToList<TDocument>(IAsyncCursorSource<TDocument>, CancellationToken)

IFindFluentExtensions.AnyAsync<TDocument, TProjection>(IFindFluent<TDocument, TProjection>, CancellationToken)

IFindFluentExtensions.Any<TDocument, TProjection>(IFindFluent<TDocument, TProjection>, CancellationToken)

IFindFluentExtensions.FirstAsync<TDocument, TProjection>(IFindFluent<TDocument, TProjection>, CancellationToken)

IFindFluentExtensions.FirstOrDefaultAsync<TDocument, TProjection>(IFindFluent<TDocument, TProjection>, CancellationToken)

IFindFluentExtensions.FirstOrDefault<TDocument, TProjection>(IFindFluent<TDocument, TProjection>, CancellationToken)

IFindFluentExtensions.First<TDocument, TProjection>(IFindFluent<TDocument, TProjection>, CancellationToken)

IFindFluentExtensions.Project<TDocument, TProjection>(IFindFluent<TDocument, TProjection>, ProjectionDefinition<TDocument, BsonDocument>)

IFindFluentExtensions.Project<TDocument, TProjection, TNewProjection>(IFindFluent<TDocument, TProjection>, Expression<Func<TDocument, TNewProjection>>)

IFindFluentExtensions.SingleAsync<TDocument, TProjection>(IFindFluent<TDocument, TProjection>, CancellationToken)

IFindFluentExtensions.SingleOrDefaultAsync<TDocument, TProjection>(IFindFluent<TDocument, TProjection>, CancellationToken)

IFindFluentExtensions.SingleOrDefault<TDocument, TProjection>(IFindFluent<TDocument, TProjection>, CancellationToken)

IFindFluentExtensions.Single<TDocument, TProjection>(IFindFluent<TDocument, TProjection>, CancellationToken)

IFindFluentExtensions.SortByDescending<TDocument, TProjection>(IFindFluent<TDocument, TProjection>, Expression<Func<TDocument, object>>)

IFindFluentExtensions.SortBy<TDocument, TProjection>(IFindFluent<TDocument, TProjection>, Expression<Func<TDocument, object>>)

IFindFluentExtensions.ThenByDescending<TDocument, TProjection>(IOrderedFindFluent<TDocument, TProjection>, Expression<Func<TDocument, object>>)

IFindFluentExtensions.ThenBy<TDocument, TProjection>(IOrderedFindFluent<TDocument, TProjection>, Expression<Func<TDocument, object>>)

Properties

Filter

Gets or sets the filter.

public abstract FilterDefinition<TDocument> Filter { get; set; }

Property Value

FilterDefinition<TDocument>

Options

Gets the options.

public abstract FindOptions<TDocument, TProjection> Options { get; }

Property Value

FindOptions<TDocument, TProjection>

Methods

As<TResult>(IBsonSerializer<TResult>)

A simplified type of projection that changes the result type by using a different serializer.

public abstract IFindFluent<TDocument, TResult> As<TResult>(IBsonSerializer<TResult> resultSerializer)

Parameters

resultSerializer IBsonSerializer<TResult>

The result serializer.

Returns

IFindFluent<TDocument, TResult>

The fluent find interface.

Type Parameters

TResult

The type of the result.

Count(CancellationToken)

Counts the number of documents.

[Obsolete("Use CountDocuments instead.")]
public virtual long Count(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

The cancellation token.

Returns

long

The count.

CountAsync(CancellationToken)

Counts the number of documents.

[Obsolete("Use CountDocumentsAsync instead.")]
public abstract Task<long> CountAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

The cancellation token.

Returns

Task<long>

A Task whose result is the count.

CountDocuments(CancellationToken)

Counts the number of documents.

public virtual long CountDocuments(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

The cancellation token.

Returns

long

The count.

Remarks

Note: when migrating from Count to CountDocuments the following query operations must be replaced:

+-------------+--------------------------------+
| Operator    | Replacement                    |
+=============+================================+
| $where      |  $expr                         |
+-------------+--------------------------------+
| $near       |  $geoWithin with $center       |
+-------------+--------------------------------+
| $nearSphere |  $geoWithin with $centerSphere |
+-------------+--------------------------------+

CountDocumentsAsync(CancellationToken)

Counts the number of documents.

public virtual Task<long> CountDocumentsAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

The cancellation token.

Returns

Task<long>

A Task whose result is the count.

Remarks

Note: when migrating from CountAsync to CountDocumentsAsync the following query operations must be replaced:

+-------------+--------------------------------+
| Operator    | Replacement                    |
+=============+================================+
| $where      |  $expr                         |
+-------------+--------------------------------+
| $near       |  $geoWithin with $center       |
+-------------+--------------------------------+
| $nearSphere |  $geoWithin with $centerSphere |
+-------------+--------------------------------+

Limit(int?)

Limits the number of documents.

public abstract IFindFluent<TDocument, TProjection> Limit(int? limit)

Parameters

limit int?

The limit.

Returns

IFindFluent<TDocument, TProjection>

The fluent find interface.

Remarks

Limit of zero or null is equivalent to setting no limit.

Project<TNewProjection>(ProjectionDefinition<TDocument, TNewProjection>)

Projects the the result.

public abstract IFindFluent<TDocument, TNewProjection> Project<TNewProjection>(ProjectionDefinition<TDocument, TNewProjection> projection)

Parameters

projection ProjectionDefinition<TDocument, TNewProjection>

The projection.

Returns

IFindFluent<TDocument, TNewProjection>

The fluent find interface.

Type Parameters

TNewProjection

The type of the projection.

Skip(int?)

Skips the the specified number of documents.

public abstract IFindFluent<TDocument, TProjection> Skip(int? skip)

Parameters

skip int?

The skip.

Returns

IFindFluent<TDocument, TProjection>

The fluent find interface.

Sort(SortDefinition<TDocument>)

Sorts the the documents.

public abstract IFindFluent<TDocument, TProjection> Sort(SortDefinition<TDocument> sort)

Parameters

sort SortDefinition<TDocument>

The sort.

Returns

IFindFluent<TDocument, TProjection>

The fluent find interface.

ToCursor(CancellationToken)

Executes the operation and returns a cursor to the results.

public virtual IAsyncCursor<TProjection> ToCursor(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

The cancellation token.

Returns

IAsyncCursor<TProjection>

A cursor.

ToCursorAsync(CancellationToken)

Executes the operation and returns a cursor to the results.

public abstract Task<IAsyncCursor<TProjection>> ToCursorAsync(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

The cancellation token.

Returns

Task<IAsyncCursor<TProjection>>

A Task whose result is a cursor.