Class MongoCollectionBase<TDocument>

Namespace: MongoDB.Driver

Assembly: MongoDB.Driver.dll

Base class for implementors of IMongoCollection<TDocument>.

public abstract class MongoCollectionBase<TDocument> : IMongoCollection<TDocument>

Type Parameters

TDocument: The type of the document.

Inheritance: object

MongoCollectionBase<TDocument>

Implements: IMongoCollection<TDocument>

Inherited Members: object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods: IMongoCollectionExtensions.Aggregate<TDocument>(IMongoCollection<TDocument>, AggregateOptions)

IMongoCollectionExtensions.Aggregate<TDocument>(IMongoCollection<TDocument>, IClientSessionHandle, AggregateOptions)

IMongoCollectionExtensions.AsQueryable<TDocument>(IMongoCollection<TDocument>, AggregateOptions)

IMongoCollectionExtensions.AsQueryable<TDocument>(IMongoCollection<TDocument>, IClientSessionHandle, AggregateOptions)

IMongoCollectionExtensions.CountAsync<TDocument>(IMongoCollection<TDocument>, IClientSessionHandle, Expression<Func<TDocument, bool>>, CountOptions, CancellationToken)

IMongoCollectionExtensions.CountAsync<TDocument>(IMongoCollection<TDocument>, Expression<Func<TDocument, bool>>, CountOptions, CancellationToken)

IMongoCollectionExtensions.CountDocumentsAsync<TDocument>(IMongoCollection<TDocument>, IClientSessionHandle, Expression<Func<TDocument, bool>>, CountOptions, CancellationToken)

IMongoCollectionExtensions.CountDocumentsAsync<TDocument>(IMongoCollection<TDocument>, Expression<Func<TDocument, bool>>, CountOptions, CancellationToken)

IMongoCollectionExtensions.CountDocuments<TDocument>(IMongoCollection<TDocument>, IClientSessionHandle, Expression<Func<TDocument, bool>>, CountOptions, CancellationToken)

IMongoCollectionExtensions.CountDocuments<TDocument>(IMongoCollection<TDocument>, Expression<Func<TDocument, bool>>, CountOptions, CancellationToken)

IMongoCollectionExtensions.Count<TDocument>(IMongoCollection<TDocument>, IClientSessionHandle, Expression<Func<TDocument, bool>>, CountOptions, CancellationToken)

IMongoCollectionExtensions.Count<TDocument>(IMongoCollection<TDocument>, Expression<Func<TDocument, bool>>, CountOptions, CancellationToken)

IMongoCollectionExtensions.DeleteManyAsync<TDocument>(IMongoCollection<TDocument>, IClientSessionHandle, Expression<Func<TDocument, bool>>, DeleteOptions, CancellationToken)

IMongoCollectionExtensions.DeleteManyAsync<TDocument>(IMongoCollection<TDocument>, Expression<Func<TDocument, bool>>, DeleteOptions, CancellationToken)

IMongoCollectionExtensions.DeleteManyAsync<TDocument>(IMongoCollection<TDocument>, Expression<Func<TDocument, bool>>, CancellationToken)

IMongoCollectionExtensions.DeleteMany<TDocument>(IMongoCollection<TDocument>, IClientSessionHandle, Expression<Func<TDocument, bool>>, DeleteOptions, CancellationToken)

IMongoCollectionExtensions.DeleteMany<TDocument>(IMongoCollection<TDocument>, Expression<Func<TDocument, bool>>, DeleteOptions, CancellationToken)

IMongoCollectionExtensions.DeleteMany<TDocument>(IMongoCollection<TDocument>, Expression<Func<TDocument, bool>>, CancellationToken)

IMongoCollectionExtensions.DeleteOneAsync<TDocument>(IMongoCollection<TDocument>, IClientSessionHandle, Expression<Func<TDocument, bool>>, DeleteOptions, CancellationToken)

IMongoCollectionExtensions.DeleteOneAsync<TDocument>(IMongoCollection<TDocument>, Expression<Func<TDocument, bool>>, DeleteOptions, CancellationToken)

IMongoCollectionExtensions.DeleteOneAsync<TDocument>(IMongoCollection<TDocument>, Expression<Func<TDocument, bool>>, CancellationToken)

IMongoCollectionExtensions.DeleteOne<TDocument>(IMongoCollection<TDocument>, IClientSessionHandle, Expression<Func<TDocument, bool>>, DeleteOptions, CancellationToken)

IMongoCollectionExtensions.DeleteOne<TDocument>(IMongoCollection<TDocument>, Expression<Func<TDocument, bool>>, DeleteOptions, CancellationToken)

IMongoCollectionExtensions.DeleteOne<TDocument>(IMongoCollection<TDocument>, Expression<Func<TDocument, bool>>, CancellationToken)

IMongoCollectionExtensions.DistinctAsync<TDocument, TField>(IMongoCollection<TDocument>, FieldDefinition<TDocument, TField>, Expression<Func<TDocument, bool>>, DistinctOptions, CancellationToken)

IMongoCollectionExtensions.DistinctAsync<TDocument, TField>(IMongoCollection<TDocument>, IClientSessionHandle, FieldDefinition<TDocument, TField>, Expression<Func<TDocument, bool>>, DistinctOptions, CancellationToken)

IMongoCollectionExtensions.DistinctAsync<TDocument, TField>(IMongoCollection<TDocument>, IClientSessionHandle, Expression<Func<TDocument, TField>>, FilterDefinition<TDocument>, DistinctOptions, CancellationToken)

IMongoCollectionExtensions.DistinctAsync<TDocument, TField>(IMongoCollection<TDocument>, IClientSessionHandle, Expression<Func<TDocument, TField>>, Expression<Func<TDocument, bool>>, DistinctOptions, CancellationToken)

IMongoCollectionExtensions.DistinctAsync<TDocument, TField>(IMongoCollection<TDocument>, Expression<Func<TDocument, TField>>, FilterDefinition<TDocument>, DistinctOptions, CancellationToken)

IMongoCollectionExtensions.DistinctAsync<TDocument, TField>(IMongoCollection<TDocument>, Expression<Func<TDocument, TField>>, Expression<Func<TDocument, bool>>, DistinctOptions, CancellationToken)

IMongoCollectionExtensions.Distinct<TDocument, TField>(IMongoCollection<TDocument>, FieldDefinition<TDocument, TField>, Expression<Func<TDocument, bool>>, DistinctOptions, CancellationToken)

IMongoCollectionExtensions.Distinct<TDocument, TField>(IMongoCollection<TDocument>, IClientSessionHandle, FieldDefinition<TDocument, TField>, Expression<Func<TDocument, bool>>, DistinctOptions, CancellationToken)

IMongoCollectionExtensions.Distinct<TDocument, TField>(IMongoCollection<TDocument>, IClientSessionHandle, Expression<Func<TDocument, TField>>, FilterDefinition<TDocument>, DistinctOptions, CancellationToken)

IMongoCollectionExtensions.Distinct<TDocument, TField>(IMongoCollection<TDocument>, IClientSessionHandle, Expression<Func<TDocument, TField>>, Expression<Func<TDocument, bool>>, DistinctOptions, CancellationToken)

IMongoCollectionExtensions.Distinct<TDocument, TField>(IMongoCollection<TDocument>, Expression<Func<TDocument, TField>>, FilterDefinition<TDocument>, DistinctOptions, CancellationToken)

IMongoCollectionExtensions.Distinct<TDocument, TField>(IMongoCollection<TDocument>, Expression<Func<TDocument, TField>>, Expression<Func<TDocument, bool>>, DistinctOptions, CancellationToken)

IMongoCollectionExtensions.FindAsync<TDocument>(IMongoCollection<TDocument>, FilterDefinition<TDocument>, FindOptions<TDocument, TDocument>, CancellationToken)

IMongoCollectionExtensions.FindAsync<TDocument>(IMongoCollection<TDocument>, IClientSessionHandle, FilterDefinition<TDocument>, FindOptions<TDocument, TDocument>, CancellationToken)

IMongoCollectionExtensions.FindAsync<TDocument>(IMongoCollection<TDocument>, IClientSessionHandle, Expression<Func<TDocument, bool>>, FindOptions<TDocument, TDocument>, CancellationToken)

IMongoCollectionExtensions.FindAsync<TDocument>(IMongoCollection<TDocument>, Expression<Func<TDocument, bool>>, FindOptions<TDocument, TDocument>, CancellationToken)

IMongoCollectionExtensions.FindOneAndDeleteAsync<TDocument>(IMongoCollection<TDocument>, FilterDefinition<TDocument>, FindOneAndDeleteOptions<TDocument, TDocument>, CancellationToken)

IMongoCollectionExtensions.FindOneAndDeleteAsync<TDocument>(IMongoCollection<TDocument>, IClientSessionHandle, FilterDefinition<TDocument>, FindOneAndDeleteOptions<TDocument, TDocument>, CancellationToken)

IMongoCollectionExtensions.FindOneAndDeleteAsync<TDocument>(IMongoCollection<TDocument>, IClientSessionHandle, Expression<Func<TDocument, bool>>, FindOneAndDeleteOptions<TDocument, TDocument>, CancellationToken)

IMongoCollectionExtensions.FindOneAndDeleteAsync<TDocument>(IMongoCollection<TDocument>, Expression<Func<TDocument, bool>>, FindOneAndDeleteOptions<TDocument, TDocument>, CancellationToken)

IMongoCollectionExtensions.FindOneAndDeleteAsync<TDocument, TProjection>(IMongoCollection<TDocument>, IClientSessionHandle, Expression<Func<TDocument, bool>>, FindOneAndDeleteOptions<TDocument, TProjection>, CancellationToken)

IMongoCollectionExtensions.FindOneAndDeleteAsync<TDocument, TProjection>(IMongoCollection<TDocument>, Expression<Func<TDocument, bool>>, FindOneAndDeleteOptions<TDocument, TProjection>, CancellationToken)

IMongoCollectionExtensions.FindOneAndDelete<TDocument>(IMongoCollection<TDocument>, FilterDefinition<TDocument>, FindOneAndDeleteOptions<TDocument, TDocument>, CancellationToken)

IMongoCollectionExtensions.FindOneAndDelete<TDocument>(IMongoCollection<TDocument>, IClientSessionHandle, FilterDefinition<TDocument>, FindOneAndDeleteOptions<TDocument, TDocument>, CancellationToken)

IMongoCollectionExtensions.FindOneAndDelete<TDocument>(IMongoCollection<TDocument>, IClientSessionHandle, Expression<Func<TDocument, bool>>, FindOneAndDeleteOptions<TDocument, TDocument>, CancellationToken)

IMongoCollectionExtensions.FindOneAndDelete<TDocument>(IMongoCollection<TDocument>, Expression<Func<TDocument, bool>>, FindOneAndDeleteOptions<TDocument, TDocument>, CancellationToken)

IMongoCollectionExtensions.FindOneAndDelete<TDocument, TProjection>(IMongoCollection<TDocument>, IClientSessionHandle, Expression<Func<TDocument, bool>>, FindOneAndDeleteOptions<TDocument, TProjection>, CancellationToken)

IMongoCollectionExtensions.FindOneAndDelete<TDocument, TProjection>(IMongoCollection<TDocument>, Expression<Func<TDocument, bool>>, FindOneAndDeleteOptions<TDocument, TProjection>, CancellationToken)

IMongoCollectionExtensions.FindOneAndReplaceAsync<TDocument>(IMongoCollection<TDocument>, FilterDefinition<TDocument>, TDocument, FindOneAndReplaceOptions<TDocument, TDocument>, CancellationToken)

IMongoCollectionExtensions.FindOneAndReplaceAsync<TDocument>(IMongoCollection<TDocument>, IClientSessionHandle, FilterDefinition<TDocument>, TDocument, FindOneAndReplaceOptions<TDocument, TDocument>, CancellationToken)

IMongoCollectionExtensions.FindOneAndReplaceAsync<TDocument>(IMongoCollection<TDocument>, Expression<Func<TDocument, bool>>, IClientSessionHandle, TDocument, FindOneAndReplaceOptions<TDocument, TDocument>, CancellationToken)

IMongoCollectionExtensions.FindOneAndReplaceAsync<TDocument>(IMongoCollection<TDocument>, Expression<Func<TDocument, bool>>, TDocument, FindOneAndReplaceOptions<TDocument, TDocument>, CancellationToken)

IMongoCollectionExtensions.FindOneAndReplaceAsync<TDocument, TProjection>(IMongoCollection<TDocument>, IClientSessionHandle, Expression<Func<TDocument, bool>>, TDocument, FindOneAndReplaceOptions<TDocument, TProjection>, CancellationToken)

IMongoCollectionExtensions.FindOneAndReplaceAsync<TDocument, TProjection>(IMongoCollection<TDocument>, Expression<Func<TDocument, bool>>, TDocument, FindOneAndReplaceOptions<TDocument, TProjection>, CancellationToken)

IMongoCollectionExtensions.FindOneAndReplace<TDocument>(IMongoCollection<TDocument>, FilterDefinition<TDocument>, TDocument, FindOneAndReplaceOptions<TDocument, TDocument>, CancellationToken)

IMongoCollectionExtensions.FindOneAndReplace<TDocument>(IMongoCollection<TDocument>, IClientSessionHandle, FilterDefinition<TDocument>, TDocument, FindOneAndReplaceOptions<TDocument, TDocument>, CancellationToken)

IMongoCollectionExtensions.FindOneAndReplace<TDocument>(IMongoCollection<TDocument>, IClientSessionHandle, Expression<Func<TDocument, bool>>, TDocument, FindOneAndReplaceOptions<TDocument, TDocument>, CancellationToken)

IMongoCollectionExtensions.FindOneAndReplace<TDocument>(IMongoCollection<TDocument>, Expression<Func<TDocument, bool>>, TDocument, FindOneAndReplaceOptions<TDocument, TDocument>, CancellationToken)

IMongoCollectionExtensions.FindOneAndReplace<TDocument, TProjection>(IMongoCollection<TDocument>, IClientSessionHandle, Expression<Func<TDocument, bool>>, TDocument, FindOneAndReplaceOptions<TDocument, TProjection>, CancellationToken)

IMongoCollectionExtensions.FindOneAndReplace<TDocument, TProjection>(IMongoCollection<TDocument>, Expression<Func<TDocument, bool>>, TDocument, FindOneAndReplaceOptions<TDocument, TProjection>, CancellationToken)

IMongoCollectionExtensions.FindOneAndUpdateAsync<TDocument>(IMongoCollection<TDocument>, FilterDefinition<TDocument>, UpdateDefinition<TDocument>, FindOneAndUpdateOptions<TDocument, TDocument>, CancellationToken)

IMongoCollectionExtensions.FindOneAndUpdateAsync<TDocument>(IMongoCollection<TDocument>, IClientSessionHandle, FilterDefinition<TDocument>, UpdateDefinition<TDocument>, FindOneAndUpdateOptions<TDocument, TDocument>, CancellationToken)

IMongoCollectionExtensions.FindOneAndUpdateAsync<TDocument>(IMongoCollection<TDocument>, IClientSessionHandle, Expression<Func<TDocument, bool>>, UpdateDefinition<TDocument>, FindOneAndUpdateOptions<TDocument, TDocument>, CancellationToken)

IMongoCollectionExtensions.FindOneAndUpdateAsync<TDocument>(IMongoCollection<TDocument>, Expression<Func<TDocument, bool>>, UpdateDefinition<TDocument>, FindOneAndUpdateOptions<TDocument, TDocument>, CancellationToken)

IMongoCollectionExtensions.FindOneAndUpdateAsync<TDocument, TProjection>(IMongoCollection<TDocument>, IClientSessionHandle, Expression<Func<TDocument, bool>>, UpdateDefinition<TDocument>, FindOneAndUpdateOptions<TDocument, TProjection>, CancellationToken)

IMongoCollectionExtensions.FindOneAndUpdateAsync<TDocument, TProjection>(IMongoCollection<TDocument>, Expression<Func<TDocument, bool>>, UpdateDefinition<TDocument>, FindOneAndUpdateOptions<TDocument, TProjection>, CancellationToken)

IMongoCollectionExtensions.FindOneAndUpdate<TDocument>(IMongoCollection<TDocument>, FilterDefinition<TDocument>, UpdateDefinition<TDocument>, FindOneAndUpdateOptions<TDocument, TDocument>, CancellationToken)

IMongoCollectionExtensions.FindOneAndUpdate<TDocument>(IMongoCollection<TDocument>, IClientSessionHandle, FilterDefinition<TDocument>, UpdateDefinition<TDocument>, FindOneAndUpdateOptions<TDocument, TDocument>, CancellationToken)

IMongoCollectionExtensions.FindOneAndUpdate<TDocument>(IMongoCollection<TDocument>, IClientSessionHandle, Expression<Func<TDocument, bool>>, UpdateDefinition<TDocument>, FindOneAndUpdateOptions<TDocument, TDocument>, CancellationToken)

IMongoCollectionExtensions.FindOneAndUpdate<TDocument>(IMongoCollection<TDocument>, Expression<Func<TDocument, bool>>, UpdateDefinition<TDocument>, FindOneAndUpdateOptions<TDocument, TDocument>, CancellationToken)

IMongoCollectionExtensions.FindOneAndUpdate<TDocument, TProjection>(IMongoCollection<TDocument>, IClientSessionHandle, Expression<Func<TDocument, bool>>, UpdateDefinition<TDocument>, FindOneAndUpdateOptions<TDocument, TProjection>, CancellationToken)

IMongoCollectionExtensions.FindOneAndUpdate<TDocument, TProjection>(IMongoCollection<TDocument>, Expression<Func<TDocument, bool>>, UpdateDefinition<TDocument>, FindOneAndUpdateOptions<TDocument, TProjection>, CancellationToken)

IMongoCollectionExtensions.FindSync<TDocument>(IMongoCollection<TDocument>, FilterDefinition<TDocument>, FindOptions<TDocument, TDocument>, CancellationToken)

IMongoCollectionExtensions.FindSync<TDocument>(IMongoCollection<TDocument>, IClientSessionHandle, FilterDefinition<TDocument>, FindOptions<TDocument, TDocument>, CancellationToken)

IMongoCollectionExtensions.FindSync<TDocument>(IMongoCollection<TDocument>, IClientSessionHandle, Expression<Func<TDocument, bool>>, FindOptions<TDocument, TDocument>, CancellationToken)

IMongoCollectionExtensions.FindSync<TDocument>(IMongoCollection<TDocument>, Expression<Func<TDocument, bool>>, FindOptions<TDocument, TDocument>, CancellationToken)

IMongoCollectionExtensions.Find<TDocument>(IMongoCollection<TDocument>, FilterDefinition<TDocument>, FindOptions)

IMongoCollectionExtensions.Find<TDocument>(IMongoCollection<TDocument>, IClientSessionHandle, FilterDefinition<TDocument>, FindOptions)

IMongoCollectionExtensions.Find<TDocument>(IMongoCollection<TDocument>, IClientSessionHandle, Expression<Func<TDocument, bool>>, FindOptions)

IMongoCollectionExtensions.Find<TDocument>(IMongoCollection<TDocument>, Expression<Func<TDocument, bool>>, FindOptions)

IMongoCollectionExtensions.ReplaceOneAsync<TDocument>(IMongoCollection<TDocument>, IClientSessionHandle, Expression<Func<TDocument, bool>>, TDocument, ReplaceOptions, CancellationToken)

IMongoCollectionExtensions.ReplaceOneAsync<TDocument>(IMongoCollection<TDocument>, IClientSessionHandle, Expression<Func<TDocument, bool>>, TDocument, UpdateOptions, CancellationToken)

IMongoCollectionExtensions.ReplaceOneAsync<TDocument>(IMongoCollection<TDocument>, Expression<Func<TDocument, bool>>, TDocument, ReplaceOptions, CancellationToken)

IMongoCollectionExtensions.ReplaceOneAsync<TDocument>(IMongoCollection<TDocument>, Expression<Func<TDocument, bool>>, TDocument, UpdateOptions, CancellationToken)

IMongoCollectionExtensions.ReplaceOne<TDocument>(IMongoCollection<TDocument>, IClientSessionHandle, Expression<Func<TDocument, bool>>, TDocument, ReplaceOptions, CancellationToken)

IMongoCollectionExtensions.ReplaceOne<TDocument>(IMongoCollection<TDocument>, IClientSessionHandle, Expression<Func<TDocument, bool>>, TDocument, UpdateOptions, CancellationToken)

IMongoCollectionExtensions.ReplaceOne<TDocument>(IMongoCollection<TDocument>, Expression<Func<TDocument, bool>>, TDocument, ReplaceOptions, CancellationToken)

IMongoCollectionExtensions.ReplaceOne<TDocument>(IMongoCollection<TDocument>, Expression<Func<TDocument, bool>>, TDocument, UpdateOptions, CancellationToken)

IMongoCollectionExtensions.UpdateManyAsync<TDocument>(IMongoCollection<TDocument>, IClientSessionHandle, Expression<Func<TDocument, bool>>, UpdateDefinition<TDocument>, UpdateOptions, CancellationToken)

IMongoCollectionExtensions.UpdateManyAsync<TDocument>(IMongoCollection<TDocument>, Expression<Func<TDocument, bool>>, UpdateDefinition<TDocument>, UpdateOptions, CancellationToken)

IMongoCollectionExtensions.UpdateMany<TDocument>(IMongoCollection<TDocument>, IClientSessionHandle, Expression<Func<TDocument, bool>>, UpdateDefinition<TDocument>, UpdateOptions, CancellationToken)

IMongoCollectionExtensions.UpdateMany<TDocument>(IMongoCollection<TDocument>, Expression<Func<TDocument, bool>>, UpdateDefinition<TDocument>, UpdateOptions, CancellationToken)

IMongoCollectionExtensions.UpdateOneAsync<TDocument>(IMongoCollection<TDocument>, IClientSessionHandle, Expression<Func<TDocument, bool>>, UpdateDefinition<TDocument>, UpdateOptions, CancellationToken)

IMongoCollectionExtensions.UpdateOneAsync<TDocument>(IMongoCollection<TDocument>, Expression<Func<TDocument, bool>>, UpdateDefinition<TDocument>, UpdateOptions, CancellationToken)

IMongoCollectionExtensions.UpdateOne<TDocument>(IMongoCollection<TDocument>, IClientSessionHandle, Expression<Func<TDocument, bool>>, UpdateDefinition<TDocument>, UpdateOptions, CancellationToken)

IMongoCollectionExtensions.UpdateOne<TDocument>(IMongoCollection<TDocument>, Expression<Func<TDocument, bool>>, UpdateDefinition<TDocument>, UpdateOptions, CancellationToken)

IMongoCollectionExtensions.WatchAsync<TDocument>(IMongoCollection<TDocument>, ChangeStreamOptions, CancellationToken)

IMongoCollectionExtensions.WatchAsync<TDocument>(IMongoCollection<TDocument>, IClientSessionHandle, ChangeStreamOptions, CancellationToken)

IMongoCollectionExtensions.Watch<TDocument>(IMongoCollection<TDocument>, ChangeStreamOptions, CancellationToken)

IMongoCollectionExtensions.Watch<TDocument>(IMongoCollection<TDocument>, IClientSessionHandle, ChangeStreamOptions, CancellationToken)

Properties

CollectionNamespace

Gets the namespace of the collection.

public abstract CollectionNamespace CollectionNamespace { get; }

Property Value

CollectionNamespace

Database

Gets the database.

public abstract IMongoDatabase Database { get; }

Property Value

IMongoDatabase

DocumentSerializer

Gets the document serializer.

public abstract IBsonSerializer<TDocument> DocumentSerializer { get; }

Property Value

IBsonSerializer<TDocument>

Indexes

Gets the index manager.

public abstract IMongoIndexManager<TDocument> Indexes { get; }

Property Value

IMongoIndexManager<TDocument>

SearchIndexes

Gets the search index manager.

public abstract IMongoSearchIndexManager SearchIndexes { get; }

Property Value

IMongoSearchIndexManager

Settings

Gets the settings.

public abstract MongoCollectionSettings Settings { get; }

Property Value

MongoCollectionSettings

Methods

AggregateAsync<TResult>(IClientSessionHandle, PipelineDefinition<TDocument, TResult>, AggregateOptions, CancellationToken)

Runs an aggregation pipeline.

public virtual Task<IAsyncCursor<TResult>> AggregateAsync<TResult>(IClientSessionHandle session, PipelineDefinition<TDocument, TResult> pipeline, AggregateOptions options = null, CancellationToken cancellationToken = default)

Parameters

session IClientSessionHandle: The session.
pipeline PipelineDefinition<TDocument, TResult>: The pipeline.
options AggregateOptions: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

Task<IAsyncCursor<TResult>>: A Task whose result is a cursor.

Type Parameters

TResult: The type of the result.

AggregateAsync<TResult>(PipelineDefinition<TDocument, TResult>, AggregateOptions, CancellationToken)

Runs an aggregation pipeline.

public abstract Task<IAsyncCursor<TResult>> AggregateAsync<TResult>(PipelineDefinition<TDocument, TResult> pipeline, AggregateOptions options = null, CancellationToken cancellationToken = default)

Parameters

pipeline PipelineDefinition<TDocument, TResult>: The pipeline.
options AggregateOptions: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

Task<IAsyncCursor<TResult>>: A Task whose result is a cursor.

Type Parameters

TResult: The type of the result.

AggregateToCollectionAsync<TResult>(IClientSessionHandle, PipelineDefinition<TDocument, TResult>, AggregateOptions, CancellationToken)

Runs an aggregation pipeline whose results are written to a collection.

public virtual Task AggregateToCollectionAsync<TResult>(IClientSessionHandle session, PipelineDefinition<TDocument, TResult> pipeline, AggregateOptions options = null, CancellationToken cancellationToken = default)

Parameters

session IClientSessionHandle: The session.
pipeline PipelineDefinition<TDocument, TResult>: The pipeline.
options AggregateOptions: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

Task: A Task.

Type Parameters

TResult: The type of the result.

AggregateToCollectionAsync<TResult>(PipelineDefinition<TDocument, TResult>, AggregateOptions, CancellationToken)

Runs an aggregation pipeline whose results are written to a collection.

public virtual Task AggregateToCollectionAsync<TResult>(PipelineDefinition<TDocument, TResult> pipeline, AggregateOptions options = null, CancellationToken cancellationToken = default)

Parameters

pipeline PipelineDefinition<TDocument, TResult>: The pipeline.
options AggregateOptions: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

Task: A Task.

Type Parameters

TResult: The type of the result.

AggregateToCollection<TResult>(IClientSessionHandle, PipelineDefinition<TDocument, TResult>, AggregateOptions, CancellationToken)

Runs an aggregation pipeline whose results are written to a collection.

public virtual void AggregateToCollection<TResult>(IClientSessionHandle session, PipelineDefinition<TDocument, TResult> pipeline, AggregateOptions options = null, CancellationToken cancellationToken = default)

Parameters

session IClientSessionHandle: The session.
pipeline PipelineDefinition<TDocument, TResult>: The pipeline.
options AggregateOptions: The options.
cancellationToken CancellationToken: The cancellation token.

Type Parameters

TResult: The type of the result.

AggregateToCollection<TResult>(PipelineDefinition<TDocument, TResult>, AggregateOptions, CancellationToken)

Runs an aggregation pipeline whose results are written to a collection.

public virtual void AggregateToCollection<TResult>(PipelineDefinition<TDocument, TResult> pipeline, AggregateOptions options = null, CancellationToken cancellationToken = default)

Parameters

pipeline PipelineDefinition<TDocument, TResult>: The pipeline.
options AggregateOptions: The options.
cancellationToken CancellationToken: The cancellation token.

Type Parameters

TResult: The type of the result.

Aggregate<TResult>(IClientSessionHandle, PipelineDefinition<TDocument, TResult>, AggregateOptions, CancellationToken)

Runs an aggregation pipeline.

public virtual IAsyncCursor<TResult> Aggregate<TResult>(IClientSessionHandle session, PipelineDefinition<TDocument, TResult> pipeline, AggregateOptions options = null, CancellationToken cancellationToken = default)

Parameters

session IClientSessionHandle: The session.
pipeline PipelineDefinition<TDocument, TResult>: The pipeline.
options AggregateOptions: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

IAsyncCursor<TResult>: A cursor.

Type Parameters

TResult: The type of the result.

Aggregate<TResult>(PipelineDefinition<TDocument, TResult>, AggregateOptions, CancellationToken)

Runs an aggregation pipeline.

public virtual IAsyncCursor<TResult> Aggregate<TResult>(PipelineDefinition<TDocument, TResult> pipeline, AggregateOptions options = null, CancellationToken cancellationToken = default)

Parameters

pipeline PipelineDefinition<TDocument, TResult>: The pipeline.
options AggregateOptions: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

IAsyncCursor<TResult>: A cursor.

Type Parameters

TResult: The type of the result.

BulkWrite(IClientSessionHandle, IEnumerable<WriteModel<TDocument>>, BulkWriteOptions, CancellationToken)

Performs multiple write operations.

public virtual BulkWriteResult<TDocument> BulkWrite(IClientSessionHandle session, IEnumerable<WriteModel<TDocument>> requests, BulkWriteOptions options = null, CancellationToken cancellationToken = default)

Parameters

session IClientSessionHandle: The session.
requests IEnumerable<WriteModel<TDocument>>: The requests.
options BulkWriteOptions: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

BulkWriteResult<TDocument>: The result of writing.

BulkWrite(IEnumerable<WriteModel<TDocument>>, BulkWriteOptions, CancellationToken)

Performs multiple write operations.

public virtual BulkWriteResult<TDocument> BulkWrite(IEnumerable<WriteModel<TDocument>> requests, BulkWriteOptions options = null, CancellationToken cancellationToken = default)

Parameters

requests IEnumerable<WriteModel<TDocument>>: The requests.
options BulkWriteOptions: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

BulkWriteResult<TDocument>: The result of writing.

BulkWriteAsync(IClientSessionHandle, IEnumerable<WriteModel<TDocument>>, BulkWriteOptions, CancellationToken)

Performs multiple write operations.

public virtual Task<BulkWriteResult<TDocument>> BulkWriteAsync(IClientSessionHandle session, IEnumerable<WriteModel<TDocument>> requests, BulkWriteOptions options = null, CancellationToken cancellationToken = default)

Parameters

session IClientSessionHandle: The session.
requests IEnumerable<WriteModel<TDocument>>: The requests.
options BulkWriteOptions: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

Task<BulkWriteResult<TDocument>>: The result of writing.

BulkWriteAsync(IEnumerable<WriteModel<TDocument>>, BulkWriteOptions, CancellationToken)

Performs multiple write operations.

public abstract Task<BulkWriteResult<TDocument>> BulkWriteAsync(IEnumerable<WriteModel<TDocument>> requests, BulkWriteOptions options = null, CancellationToken cancellationToken = default)

Parameters

requests IEnumerable<WriteModel<TDocument>>: The requests.
options BulkWriteOptions: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

Task<BulkWriteResult<TDocument>>: The result of writing.

Count(FilterDefinition<TDocument>, CountOptions, CancellationToken)

Counts the number of documents in the collection.

[Obsolete("Use CountDocuments or EstimatedDocumentCount instead.")]
public virtual long Count(FilterDefinition<TDocument> filter, CountOptions options = null, CancellationToken cancellationToken = default)

Parameters

filter FilterDefinition<TDocument>: The filter.
options CountOptions: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

long: The number of documents in the collection.

Count(IClientSessionHandle, FilterDefinition<TDocument>, CountOptions, CancellationToken)

Counts the number of documents in the collection.

[Obsolete("Use CountDocuments or EstimatedDocumentCount instead.")]
public virtual long Count(IClientSessionHandle session, FilterDefinition<TDocument> filter, CountOptions options = null, CancellationToken cancellationToken = default)

Parameters

session IClientSessionHandle: The session.
filter FilterDefinition<TDocument>: The filter.
options CountOptions: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

long: The number of documents in the collection.

CountAsync(FilterDefinition<TDocument>, CountOptions, CancellationToken)

Counts the number of documents in the collection.

[Obsolete("Use CountDocumentsAsync or EstimatedDocumentCountAsync instead.")]
public abstract Task<long> CountAsync(FilterDefinition<TDocument> filter, CountOptions options = null, CancellationToken cancellationToken = default)

Parameters

filter FilterDefinition<TDocument>: The filter.
options CountOptions: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

Task<long>: The number of documents in the collection.

CountAsync(IClientSessionHandle, FilterDefinition<TDocument>, CountOptions, CancellationToken)

Counts the number of documents in the collection.

[Obsolete("Use CountDocumentsAsync or EstimatedDocumentCountAsync instead.")]
public virtual Task<long> CountAsync(IClientSessionHandle session, FilterDefinition<TDocument> filter, CountOptions options = null, CancellationToken cancellationToken = default)

Parameters

session IClientSessionHandle: The session.
filter FilterDefinition<TDocument>: The filter.
options CountOptions: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

Task<long>: The number of documents in the collection.

CountDocuments(FilterDefinition<TDocument>, CountOptions, CancellationToken)

Counts the number of documents in the collection. For a fast estimate of the total documents in a collection see EstimatedDocumentCount(EstimatedDocumentCountOptions, CancellationToken).

public virtual long CountDocuments(FilterDefinition<TDocument> filter, CountOptions options = null, CancellationToken cancellationToken = default)

Parameters

filter FilterDefinition<TDocument>: The filter.
options CountOptions: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

long: The number of documents in the collection.

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 |
+-------------+--------------------------------+

CountDocuments(IClientSessionHandle, FilterDefinition<TDocument>, CountOptions, CancellationToken)

Counts the number of documents in the collection. For a fast estimate of the total documents in a collection see EstimatedDocumentCount(EstimatedDocumentCountOptions, CancellationToken).

public virtual long CountDocuments(IClientSessionHandle session, FilterDefinition<TDocument> filter, CountOptions options = null, CancellationToken cancellationToken = default)

Parameters

session IClientSessionHandle: The session.
filter FilterDefinition<TDocument>: The filter.
options CountOptions: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

long: The number of documents in the collection.

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(FilterDefinition<TDocument>, CountOptions, CancellationToken)

Counts the number of documents in the collection. For a fast estimate of the total documents in a collection see .

public virtual Task<long> CountDocumentsAsync(FilterDefinition<TDocument> filter, CountOptions options = null, CancellationToken cancellationToken = default)

Parameters

filter FilterDefinition<TDocument>: The filter.
options CountOptions: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

Task<long>: The number of documents in the collection.

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 |
+-------------+--------------------------------+

CountDocumentsAsync(IClientSessionHandle, FilterDefinition<TDocument>, CountOptions, CancellationToken)

Counts the number of documents in the collection. For a fast estimate of the total documents in a collection see EstimatedDocumentCountAsync(EstimatedDocumentCountOptions, CancellationToken).

public virtual Task<long> CountDocumentsAsync(IClientSessionHandle session, FilterDefinition<TDocument> filter, CountOptions options = null, CancellationToken cancellationToken = default)

Parameters

session IClientSessionHandle: The session.
filter FilterDefinition<TDocument>: The filter.
options CountOptions: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

Task<long>: The number of documents in the collection.

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 |
+-------------+--------------------------------+

DeleteMany(FilterDefinition<TDocument>, DeleteOptions, CancellationToken)

Deletes multiple documents.

public virtual DeleteResult DeleteMany(FilterDefinition<TDocument> filter, DeleteOptions options, CancellationToken cancellationToken = default)

Parameters

filter FilterDefinition<TDocument>: The filter.
options DeleteOptions: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

DeleteResult: The result of the delete operation.

DeleteMany(FilterDefinition<TDocument>, CancellationToken)

Deletes multiple documents.

public virtual DeleteResult DeleteMany(FilterDefinition<TDocument> filter, CancellationToken cancellationToken = default)

Parameters

filter FilterDefinition<TDocument>: The filter.
cancellationToken CancellationToken: The cancellation token.

Returns

DeleteResult: The result of the delete operation.

DeleteMany(IClientSessionHandle, FilterDefinition<TDocument>, DeleteOptions, CancellationToken)

Deletes multiple documents.

public virtual DeleteResult DeleteMany(IClientSessionHandle session, FilterDefinition<TDocument> filter, DeleteOptions options = null, CancellationToken cancellationToken = default)

Parameters

session IClientSessionHandle: The session.
filter FilterDefinition<TDocument>: The filter.
options DeleteOptions: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

DeleteResult: The result of the delete operation.

DeleteManyAsync(FilterDefinition<TDocument>, DeleteOptions, CancellationToken)

Deletes multiple documents.

public virtual Task<DeleteResult> DeleteManyAsync(FilterDefinition<TDocument> filter, DeleteOptions options, CancellationToken cancellationToken = default)

Parameters

filter FilterDefinition<TDocument>: The filter.
options DeleteOptions: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

Task<DeleteResult>: The result of the delete operation.

DeleteManyAsync(FilterDefinition<TDocument>, CancellationToken)

Deletes multiple documents.

public virtual Task<DeleteResult> DeleteManyAsync(FilterDefinition<TDocument> filter, CancellationToken cancellationToken = default)

Parameters

filter FilterDefinition<TDocument>: The filter.
cancellationToken CancellationToken: The cancellation token.

Returns

Task<DeleteResult>: The result of the delete operation.

DeleteManyAsync(IClientSessionHandle, FilterDefinition<TDocument>, DeleteOptions, CancellationToken)

Deletes multiple documents.

public virtual Task<DeleteResult> DeleteManyAsync(IClientSessionHandle session, FilterDefinition<TDocument> filter, DeleteOptions options = null, CancellationToken cancellationToken = default)

Parameters

session IClientSessionHandle: The session.
filter FilterDefinition<TDocument>: The filter.
options DeleteOptions: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

Task<DeleteResult>: The result of the delete operation.

DeleteOne(FilterDefinition<TDocument>, DeleteOptions, CancellationToken)

Deletes a single document.

public virtual DeleteResult DeleteOne(FilterDefinition<TDocument> filter, DeleteOptions options, CancellationToken cancellationToken = default)

Parameters

filter FilterDefinition<TDocument>: The filter.
options DeleteOptions: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

DeleteResult: The result of the delete operation.

DeleteOne(FilterDefinition<TDocument>, CancellationToken)

Deletes a single document.

public virtual DeleteResult DeleteOne(FilterDefinition<TDocument> filter, CancellationToken cancellationToken = default)

Parameters

filter FilterDefinition<TDocument>: The filter.
cancellationToken CancellationToken: The cancellation token.

Returns

DeleteResult: The result of the delete operation.

DeleteOne(IClientSessionHandle, FilterDefinition<TDocument>, DeleteOptions, CancellationToken)

Deletes a single document.

public virtual DeleteResult DeleteOne(IClientSessionHandle session, FilterDefinition<TDocument> filter, DeleteOptions options = null, CancellationToken cancellationToken = default)

Parameters

session IClientSessionHandle: The session.
filter FilterDefinition<TDocument>: The filter.
options DeleteOptions: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

DeleteResult: The result of the delete operation.

DeleteOneAsync(FilterDefinition<TDocument>, DeleteOptions, CancellationToken)

Deletes a single document.

public virtual Task<DeleteResult> DeleteOneAsync(FilterDefinition<TDocument> filter, DeleteOptions options, CancellationToken cancellationToken = default)

Parameters

filter FilterDefinition<TDocument>: The filter.
options DeleteOptions: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

Task<DeleteResult>: The result of the delete operation.

DeleteOneAsync(FilterDefinition<TDocument>, CancellationToken)

Deletes a single document.

public virtual Task<DeleteResult> DeleteOneAsync(FilterDefinition<TDocument> filter, CancellationToken cancellationToken = default)

Parameters

filter FilterDefinition<TDocument>: The filter.
cancellationToken CancellationToken: The cancellation token.

Returns

Task<DeleteResult>: The result of the delete operation.

DeleteOneAsync(IClientSessionHandle, FilterDefinition<TDocument>, DeleteOptions, CancellationToken)

Deletes a single document.

public virtual Task<DeleteResult> DeleteOneAsync(IClientSessionHandle session, FilterDefinition<TDocument> filter, DeleteOptions options = null, CancellationToken cancellationToken = default)

Parameters

session IClientSessionHandle: The session.
filter FilterDefinition<TDocument>: The filter.
options DeleteOptions: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

Task<DeleteResult>: The result of the delete operation.

DistinctAsync<TField>(FieldDefinition<TDocument, TField>, FilterDefinition<TDocument>, DistinctOptions, CancellationToken)

Gets the distinct values for a specified field.

public abstract Task<IAsyncCursor<TField>> DistinctAsync<TField>(FieldDefinition<TDocument, TField> field, FilterDefinition<TDocument> filter, DistinctOptions options = null, CancellationToken cancellationToken = default)

Parameters

field FieldDefinition<TDocument, TField>: The field.
filter FilterDefinition<TDocument>: The filter.
options DistinctOptions: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

Task<IAsyncCursor<TField>>: A Task whose result is a cursor.

Type Parameters

TField: The type of the result.

DistinctAsync<TField>(IClientSessionHandle, FieldDefinition<TDocument, TField>, FilterDefinition<TDocument>, DistinctOptions, CancellationToken)

Gets the distinct values for a specified field.

public virtual Task<IAsyncCursor<TField>> DistinctAsync<TField>(IClientSessionHandle session, FieldDefinition<TDocument, TField> field, FilterDefinition<TDocument> filter, DistinctOptions options = null, CancellationToken cancellationToken = default)

Parameters

session IClientSessionHandle: The session.
field FieldDefinition<TDocument, TField>: The field.
filter FilterDefinition<TDocument>: The filter.
options DistinctOptions: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

Task<IAsyncCursor<TField>>: A Task whose result is a cursor.

Type Parameters

TField: The type of the result.

Distinct<TField>(FieldDefinition<TDocument, TField>, FilterDefinition<TDocument>, DistinctOptions, CancellationToken)

Gets the distinct values for a specified field.

public virtual IAsyncCursor<TField> Distinct<TField>(FieldDefinition<TDocument, TField> field, FilterDefinition<TDocument> filter, DistinctOptions options = null, CancellationToken cancellationToken = default)

Parameters

field FieldDefinition<TDocument, TField>: The field.
filter FilterDefinition<TDocument>: The filter.
options DistinctOptions: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

IAsyncCursor<TField>: A cursor.

Type Parameters

TField: The type of the result.

Distinct<TField>(IClientSessionHandle, FieldDefinition<TDocument, TField>, FilterDefinition<TDocument>, DistinctOptions, CancellationToken)

Gets the distinct values for a specified field.

public virtual IAsyncCursor<TField> Distinct<TField>(IClientSessionHandle session, FieldDefinition<TDocument, TField> field, FilterDefinition<TDocument> filter, DistinctOptions options = null, CancellationToken cancellationToken = default)

Parameters

session IClientSessionHandle: The session.
field FieldDefinition<TDocument, TField>: The field.
filter FilterDefinition<TDocument>: The filter.
options DistinctOptions: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

IAsyncCursor<TField>: A cursor.

Type Parameters

TField: The type of the result.

EstimatedDocumentCount(EstimatedDocumentCountOptions, CancellationToken)

Returns an estimate of the number of documents in the collection.

public virtual long EstimatedDocumentCount(EstimatedDocumentCountOptions options = null, CancellationToken cancellationToken = default)

Parameters

options EstimatedDocumentCountOptions: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

long: An estimate of the number of documents in the collection.

Remarks

Due to an oversight in versions 5.0.0-5.0.8 of MongoDB, the count command, which estimatedDocumentCount uses in its implementation, was not included in v1 of the Stable API. If you are using the Stable API with estimatedDocumentCount, you must upgrade to server version 5.0.9+ or set strict: false when configuring ServerApi to avoid encountering errors.

EstimatedDocumentCountAsync(EstimatedDocumentCountOptions, CancellationToken)

Returns an estimate of the number of documents in the collection.

public virtual Task<long> EstimatedDocumentCountAsync(EstimatedDocumentCountOptions options = null, CancellationToken cancellationToken = default)

Parameters

options EstimatedDocumentCountOptions: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

Task<long>: An estimate of the number of documents in the collection.

FindAsync<TProjection>(FilterDefinition<TDocument>, FindOptions<TDocument, TProjection>, CancellationToken)

Finds the documents matching the filter.

public abstract Task<IAsyncCursor<TProjection>> FindAsync<TProjection>(FilterDefinition<TDocument> filter, FindOptions<TDocument, TProjection> options = null, CancellationToken cancellationToken = default)

Parameters

filter FilterDefinition<TDocument>: The filter.
options FindOptions<TDocument, TProjection>: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

Task<IAsyncCursor<TProjection>>: A Task whose result is a cursor.

Type Parameters

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

FindAsync<TProjection>(IClientSessionHandle, FilterDefinition<TDocument>, FindOptions<TDocument, TProjection>, CancellationToken)

Finds the documents matching the filter.

public virtual Task<IAsyncCursor<TProjection>> FindAsync<TProjection>(IClientSessionHandle session, FilterDefinition<TDocument> filter, FindOptions<TDocument, TProjection> options = null, CancellationToken cancellationToken = default)

Parameters

session IClientSessionHandle: The session.
filter FilterDefinition<TDocument>: The filter.
options FindOptions<TDocument, TProjection>: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

Task<IAsyncCursor<TProjection>>: A Task whose result is a cursor.

Type Parameters

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

FindOneAndDeleteAsync<TProjection>(FilterDefinition<TDocument>, FindOneAndDeleteOptions<TDocument, TProjection>, CancellationToken)

Finds a single document and deletes it atomically.

public abstract Task<TProjection> FindOneAndDeleteAsync<TProjection>(FilterDefinition<TDocument> filter, FindOneAndDeleteOptions<TDocument, TProjection> options = null, CancellationToken cancellationToken = default)

Parameters

filter FilterDefinition<TDocument>: The filter.
options FindOneAndDeleteOptions<TDocument, TProjection>: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

Task<TProjection>: The returned document.

Type Parameters

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

FindOneAndDeleteAsync<TProjection>(IClientSessionHandle, FilterDefinition<TDocument>, FindOneAndDeleteOptions<TDocument, TProjection>, CancellationToken)

Finds a single document and deletes it atomically.

public virtual Task<TProjection> FindOneAndDeleteAsync<TProjection>(IClientSessionHandle session, FilterDefinition<TDocument> filter, FindOneAndDeleteOptions<TDocument, TProjection> options = null, CancellationToken cancellationToken = default)

Parameters

session IClientSessionHandle: The session.
filter FilterDefinition<TDocument>: The filter.
options FindOneAndDeleteOptions<TDocument, TProjection>: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

Task<TProjection>: The returned document.

Type Parameters

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

FindOneAndDelete<TProjection>(FilterDefinition<TDocument>, FindOneAndDeleteOptions<TDocument, TProjection>, CancellationToken)

Finds a single document and deletes it atomically.

public virtual TProjection FindOneAndDelete<TProjection>(FilterDefinition<TDocument> filter, FindOneAndDeleteOptions<TDocument, TProjection> options = null, CancellationToken cancellationToken = default)

Parameters

filter FilterDefinition<TDocument>: The filter.
options FindOneAndDeleteOptions<TDocument, TProjection>: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

TProjection: The returned document.

Type Parameters

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

FindOneAndDelete<TProjection>(IClientSessionHandle, FilterDefinition<TDocument>, FindOneAndDeleteOptions<TDocument, TProjection>, CancellationToken)

Finds a single document and deletes it atomically.

public virtual TProjection FindOneAndDelete<TProjection>(IClientSessionHandle session, FilterDefinition<TDocument> filter, FindOneAndDeleteOptions<TDocument, TProjection> options = null, CancellationToken cancellationToken = default)

Parameters

session IClientSessionHandle: The session.
filter FilterDefinition<TDocument>: The filter.
options FindOneAndDeleteOptions<TDocument, TProjection>: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

TProjection: The returned document.

Type Parameters

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

FindOneAndReplaceAsync<TProjection>(FilterDefinition<TDocument>, TDocument, FindOneAndReplaceOptions<TDocument, TProjection>, CancellationToken)

Finds a single document and replaces it atomically.

public abstract Task<TProjection> FindOneAndReplaceAsync<TProjection>(FilterDefinition<TDocument> filter, TDocument replacement, FindOneAndReplaceOptions<TDocument, TProjection> options = null, CancellationToken cancellationToken = default)

Parameters

filter FilterDefinition<TDocument>: The filter.
replacement TDocument: The replacement.
options FindOneAndReplaceOptions<TDocument, TProjection>: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

Task<TProjection>: The returned document.

Type Parameters

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

FindOneAndReplaceAsync<TProjection>(IClientSessionHandle, FilterDefinition<TDocument>, TDocument, FindOneAndReplaceOptions<TDocument, TProjection>, CancellationToken)

Finds a single document and replaces it atomically.

public virtual Task<TProjection> FindOneAndReplaceAsync<TProjection>(IClientSessionHandle session, FilterDefinition<TDocument> filter, TDocument replacement, FindOneAndReplaceOptions<TDocument, TProjection> options = null, CancellationToken cancellationToken = default)

Parameters

session IClientSessionHandle: The session.
filter FilterDefinition<TDocument>: The filter.
replacement TDocument: The replacement.
options FindOneAndReplaceOptions<TDocument, TProjection>: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

Task<TProjection>: The returned document.

Type Parameters

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

FindOneAndReplace<TProjection>(FilterDefinition<TDocument>, TDocument, FindOneAndReplaceOptions<TDocument, TProjection>, CancellationToken)

Finds a single document and replaces it atomically.

public virtual TProjection FindOneAndReplace<TProjection>(FilterDefinition<TDocument> filter, TDocument replacement, FindOneAndReplaceOptions<TDocument, TProjection> options = null, CancellationToken cancellationToken = default)

Parameters

filter FilterDefinition<TDocument>: The filter.
replacement TDocument: The replacement.
options FindOneAndReplaceOptions<TDocument, TProjection>: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

TProjection: The returned document.

Type Parameters

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

FindOneAndReplace<TProjection>(IClientSessionHandle, FilterDefinition<TDocument>, TDocument, FindOneAndReplaceOptions<TDocument, TProjection>, CancellationToken)

Finds a single document and replaces it atomically.

public virtual TProjection FindOneAndReplace<TProjection>(IClientSessionHandle session, FilterDefinition<TDocument> filter, TDocument replacement, FindOneAndReplaceOptions<TDocument, TProjection> options = null, CancellationToken cancellationToken = default)

Parameters

session IClientSessionHandle: The session.
filter FilterDefinition<TDocument>: The filter.
replacement TDocument: The replacement.
options FindOneAndReplaceOptions<TDocument, TProjection>: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

TProjection: The returned document.

Type Parameters

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

FindOneAndUpdateAsync<TProjection>(FilterDefinition<TDocument>, UpdateDefinition<TDocument>, FindOneAndUpdateOptions<TDocument, TProjection>, CancellationToken)

Finds a single document and updates it atomically.

public abstract Task<TProjection> FindOneAndUpdateAsync<TProjection>(FilterDefinition<TDocument> filter, UpdateDefinition<TDocument> update, FindOneAndUpdateOptions<TDocument, TProjection> options = null, CancellationToken cancellationToken = default)

Parameters

filter FilterDefinition<TDocument>: The filter.
update UpdateDefinition<TDocument>: The update.
options FindOneAndUpdateOptions<TDocument, TProjection>: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

Task<TProjection>: The returned document.

Type Parameters

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

FindOneAndUpdateAsync<TProjection>(IClientSessionHandle, FilterDefinition<TDocument>, UpdateDefinition<TDocument>, FindOneAndUpdateOptions<TDocument, TProjection>, CancellationToken)

Finds a single document and updates it atomically.

public virtual Task<TProjection> FindOneAndUpdateAsync<TProjection>(IClientSessionHandle session, FilterDefinition<TDocument> filter, UpdateDefinition<TDocument> update, FindOneAndUpdateOptions<TDocument, TProjection> options = null, CancellationToken cancellationToken = default)

Parameters

session IClientSessionHandle: The session.
filter FilterDefinition<TDocument>: The filter.
update UpdateDefinition<TDocument>: The update.
options FindOneAndUpdateOptions<TDocument, TProjection>: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

Task<TProjection>: The returned document.

Type Parameters

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

FindOneAndUpdate<TProjection>(FilterDefinition<TDocument>, UpdateDefinition<TDocument>, FindOneAndUpdateOptions<TDocument, TProjection>, CancellationToken)

Finds a single document and updates it atomically.

public virtual TProjection FindOneAndUpdate<TProjection>(FilterDefinition<TDocument> filter, UpdateDefinition<TDocument> update, FindOneAndUpdateOptions<TDocument, TProjection> options = null, CancellationToken cancellationToken = default)

Parameters

filter FilterDefinition<TDocument>: The filter.
update UpdateDefinition<TDocument>: The update.
options FindOneAndUpdateOptions<TDocument, TProjection>: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

TProjection: The returned document.

Type Parameters

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

FindOneAndUpdate<TProjection>(IClientSessionHandle, FilterDefinition<TDocument>, UpdateDefinition<TDocument>, FindOneAndUpdateOptions<TDocument, TProjection>, CancellationToken)

Finds a single document and updates it atomically.

public virtual TProjection FindOneAndUpdate<TProjection>(IClientSessionHandle session, FilterDefinition<TDocument> filter, UpdateDefinition<TDocument> update, FindOneAndUpdateOptions<TDocument, TProjection> options = null, CancellationToken cancellationToken = default)

Parameters

session IClientSessionHandle: The session.
filter FilterDefinition<TDocument>: The filter.
update UpdateDefinition<TDocument>: The update.
options FindOneAndUpdateOptions<TDocument, TProjection>: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

TProjection: The returned document.

Type Parameters

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

FindSync<TProjection>(FilterDefinition<TDocument>, FindOptions<TDocument, TProjection>, CancellationToken)

Finds the documents matching the filter.

public virtual IAsyncCursor<TProjection> FindSync<TProjection>(FilterDefinition<TDocument> filter, FindOptions<TDocument, TProjection> options = null, CancellationToken cancellationToken = default)

Parameters

filter FilterDefinition<TDocument>: The filter.
options FindOptions<TDocument, TProjection>: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

IAsyncCursor<TProjection>: A cursor.

Type Parameters

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

FindSync<TProjection>(IClientSessionHandle, FilterDefinition<TDocument>, FindOptions<TDocument, TProjection>, CancellationToken)

Finds the documents matching the filter.

public virtual IAsyncCursor<TProjection> FindSync<TProjection>(IClientSessionHandle session, FilterDefinition<TDocument> filter, FindOptions<TDocument, TProjection> options = null, CancellationToken cancellationToken = default)

Parameters

session IClientSessionHandle: The session.
filter FilterDefinition<TDocument>: The filter.
options FindOptions<TDocument, TProjection>: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

IAsyncCursor<TProjection>: A cursor.

Type Parameters

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

InsertMany(IClientSessionHandle, IEnumerable<TDocument>, InsertManyOptions, CancellationToken)

Inserts many documents.

public virtual void InsertMany(IClientSessionHandle session, IEnumerable<TDocument> documents, InsertManyOptions options = null, CancellationToken cancellationToken = default)

Parameters

session IClientSessionHandle: The session.
documents IEnumerable<TDocument>: The documents.
options InsertManyOptions: The options.
cancellationToken CancellationToken: The cancellation token.

InsertMany(IEnumerable<TDocument>, InsertManyOptions, CancellationToken)

Inserts many documents.

public virtual void InsertMany(IEnumerable<TDocument> documents, InsertManyOptions options = null, CancellationToken cancellationToken = default)

Parameters

documents IEnumerable<TDocument>: The documents.
options InsertManyOptions: The options.
cancellationToken CancellationToken: The cancellation token.

InsertManyAsync(IClientSessionHandle, IEnumerable<TDocument>, InsertManyOptions, CancellationToken)

Inserts many documents.

public virtual Task InsertManyAsync(IClientSessionHandle session, IEnumerable<TDocument> documents, InsertManyOptions options = null, CancellationToken cancellationToken = default)

Parameters

session IClientSessionHandle: The session.
documents IEnumerable<TDocument>: The documents.
options InsertManyOptions: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

Task: The result of the insert operation.

InsertManyAsync(IEnumerable<TDocument>, InsertManyOptions, CancellationToken)

Inserts many documents.

public virtual Task InsertManyAsync(IEnumerable<TDocument> documents, InsertManyOptions options = null, CancellationToken cancellationToken = default)

Parameters

documents IEnumerable<TDocument>: The documents.
options InsertManyOptions: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

Task: The result of the insert operation.

InsertOne(IClientSessionHandle, TDocument, InsertOneOptions, CancellationToken)

Inserts a single document.

public virtual void InsertOne(IClientSessionHandle session, TDocument document, InsertOneOptions options = null, CancellationToken cancellationToken = default)

Parameters

session IClientSessionHandle: The session.
document TDocument: The document.
options InsertOneOptions: The options.
cancellationToken CancellationToken: The cancellation token.

InsertOne(TDocument, InsertOneOptions, CancellationToken)

Inserts a single document.

public virtual void InsertOne(TDocument document, InsertOneOptions options = null, CancellationToken cancellationToken = default)

Parameters

document TDocument: The document.
options InsertOneOptions: The options.
cancellationToken CancellationToken: The cancellation token.

InsertOneAsync(IClientSessionHandle, TDocument, InsertOneOptions, CancellationToken)

Inserts a single document.

public virtual Task InsertOneAsync(IClientSessionHandle session, TDocument document, InsertOneOptions options = null, CancellationToken cancellationToken = default)

Parameters

session IClientSessionHandle: The session.
document TDocument: The document.
options InsertOneOptions: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

Task: The result of the insert operation.

InsertOneAsync(TDocument, InsertOneOptions, CancellationToken)

Inserts a single document.

public virtual Task InsertOneAsync(TDocument document, InsertOneOptions options = null, CancellationToken cancellationToken = default)

Parameters

document TDocument: The document.
options InsertOneOptions: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

Task: The result of the insert operation.

InsertOneAsync(TDocument, CancellationToken)

Inserts a single document.

[Obsolete("Use the new overload of InsertOneAsync with an InsertOneOptions parameter instead.")]
public virtual Task InsertOneAsync(TDocument document, CancellationToken _cancellationToken)

Parameters

document TDocument: The document.
_cancellationToken CancellationToken: The cancellation token.

Returns

Task: The result of the insert operation.

MapReduceAsync<TResult>(BsonJavaScript, BsonJavaScript, MapReduceOptions<TDocument, TResult>, CancellationToken)

Executes a map-reduce command.

[Obsolete("Use Aggregation pipeline instead.")]
public abstract Task<IAsyncCursor<TResult>> MapReduceAsync<TResult>(BsonJavaScript map, BsonJavaScript reduce, MapReduceOptions<TDocument, TResult> options = null, CancellationToken cancellationToken = default)

Parameters

map BsonJavaScript: The map function.
reduce BsonJavaScript: The reduce function.
options MapReduceOptions<TDocument, TResult>: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

Task<IAsyncCursor<TResult>>: A Task whose result is a cursor.

Type Parameters

TResult: The type of the result.

MapReduceAsync<TResult>(IClientSessionHandle, BsonJavaScript, BsonJavaScript, MapReduceOptions<TDocument, TResult>, CancellationToken)

Executes a map-reduce command.

[Obsolete("Use Aggregation pipeline instead.")]
public virtual Task<IAsyncCursor<TResult>> MapReduceAsync<TResult>(IClientSessionHandle session, BsonJavaScript map, BsonJavaScript reduce, MapReduceOptions<TDocument, TResult> options = null, CancellationToken cancellationToken = default)

Parameters

session IClientSessionHandle: The session.
map BsonJavaScript: The map function.
reduce BsonJavaScript: The reduce function.
options MapReduceOptions<TDocument, TResult>: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

Task<IAsyncCursor<TResult>>: A Task whose result is a cursor.

Type Parameters

TResult: The type of the result.

MapReduce<TResult>(BsonJavaScript, BsonJavaScript, MapReduceOptions<TDocument, TResult>, CancellationToken)

Executes a map-reduce command.

[Obsolete("Use Aggregation pipeline instead.")]
public virtual IAsyncCursor<TResult> MapReduce<TResult>(BsonJavaScript map, BsonJavaScript reduce, MapReduceOptions<TDocument, TResult> options = null, CancellationToken cancellationToken = default)

Parameters

map BsonJavaScript: The map function.
reduce BsonJavaScript: The reduce function.
options MapReduceOptions<TDocument, TResult>: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

IAsyncCursor<TResult>: A cursor.

Type Parameters

TResult: The type of the result.

MapReduce<TResult>(IClientSessionHandle, BsonJavaScript, BsonJavaScript, MapReduceOptions<TDocument, TResult>, CancellationToken)

Executes a map-reduce command.

[Obsolete("Use Aggregation pipeline instead.")]
public virtual IAsyncCursor<TResult> MapReduce<TResult>(IClientSessionHandle session, BsonJavaScript map, BsonJavaScript reduce, MapReduceOptions<TDocument, TResult> options = null, CancellationToken cancellationToken = default)

Parameters

session IClientSessionHandle: The session.
map BsonJavaScript: The map function.
reduce BsonJavaScript: The reduce function.
options MapReduceOptions<TDocument, TResult>: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

IAsyncCursor<TResult>: A cursor.

Type Parameters

TResult: The type of the result.

OfType<TDerivedDocument>()

Returns a filtered collection that appears to contain only documents of the derived type. All operations using this filtered collection will automatically use discriminators as necessary.

public abstract IFilteredMongoCollection<TDerivedDocument> OfType<TDerivedDocument>() where TDerivedDocument : TDocument

Returns

IFilteredMongoCollection<TDerivedDocument>: A filtered collection.

Type Parameters

TDerivedDocument: The type of the derived document.

ReplaceOne(FilterDefinition<TDocument>, TDocument, ReplaceOptions, CancellationToken)

Replaces a single document.

public virtual ReplaceOneResult ReplaceOne(FilterDefinition<TDocument> filter, TDocument replacement, ReplaceOptions options = null, CancellationToken cancellationToken = default)

Parameters

filter FilterDefinition<TDocument>: The filter.
replacement TDocument: The replacement.
options ReplaceOptions: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

ReplaceOneResult: The result of the replacement.

ReplaceOne(FilterDefinition<TDocument>, TDocument, UpdateOptions, CancellationToken)

Replaces a single document.

[Obsolete("Use the overload that takes a ReplaceOptions instead of an UpdateOptions.")]
public virtual ReplaceOneResult ReplaceOne(FilterDefinition<TDocument> filter, TDocument replacement, UpdateOptions options, CancellationToken cancellationToken = default)

Parameters

filter FilterDefinition<TDocument>: The filter.
replacement TDocument: The replacement.
options UpdateOptions: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

ReplaceOneResult: The result of the replacement.

ReplaceOne(IClientSessionHandle, FilterDefinition<TDocument>, TDocument, ReplaceOptions, CancellationToken)

Replaces a single document.

public virtual ReplaceOneResult ReplaceOne(IClientSessionHandle session, FilterDefinition<TDocument> filter, TDocument replacement, ReplaceOptions options = null, CancellationToken cancellationToken = default)

Parameters

session IClientSessionHandle: The session.
filter FilterDefinition<TDocument>: The filter.
replacement TDocument: The replacement.
options ReplaceOptions: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

ReplaceOneResult: The result of the replacement.

ReplaceOne(IClientSessionHandle, FilterDefinition<TDocument>, TDocument, UpdateOptions, CancellationToken)

Replaces a single document.

[Obsolete("Use the overload that takes a ReplaceOptions instead of an UpdateOptions.")]
public virtual ReplaceOneResult ReplaceOne(IClientSessionHandle session, FilterDefinition<TDocument> filter, TDocument replacement, UpdateOptions options, CancellationToken cancellationToken = default)

Parameters

session IClientSessionHandle: The session.
filter FilterDefinition<TDocument>: The filter.
replacement TDocument: The replacement.
options UpdateOptions: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

ReplaceOneResult: The result of the replacement.

ReplaceOneAsync(FilterDefinition<TDocument>, TDocument, ReplaceOptions, CancellationToken)

Replaces a single document.

public virtual Task<ReplaceOneResult> ReplaceOneAsync(FilterDefinition<TDocument> filter, TDocument replacement, ReplaceOptions options = null, CancellationToken cancellationToken = default)

Parameters

filter FilterDefinition<TDocument>: The filter.
replacement TDocument: The replacement.
options ReplaceOptions: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

Task<ReplaceOneResult>: The result of the replacement.

ReplaceOneAsync(FilterDefinition<TDocument>, TDocument, UpdateOptions, CancellationToken)

Replaces a single document.

[Obsolete("Use the overload that takes a ReplaceOptions instead of an UpdateOptions.")]
public virtual Task<ReplaceOneResult> ReplaceOneAsync(FilterDefinition<TDocument> filter, TDocument replacement, UpdateOptions options, CancellationToken cancellationToken = default)

Parameters

filter FilterDefinition<TDocument>: The filter.
replacement TDocument: The replacement.
options UpdateOptions: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

Task<ReplaceOneResult>: The result of the replacement.

ReplaceOneAsync(IClientSessionHandle, FilterDefinition<TDocument>, TDocument, ReplaceOptions, CancellationToken)

Replaces a single document.

public virtual Task<ReplaceOneResult> ReplaceOneAsync(IClientSessionHandle session, FilterDefinition<TDocument> filter, TDocument replacement, ReplaceOptions options = null, CancellationToken cancellationToken = default)

Parameters

session IClientSessionHandle: The session.
filter FilterDefinition<TDocument>: The filter.
replacement TDocument: The replacement.
options ReplaceOptions: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

Task<ReplaceOneResult>: The result of the replacement.

ReplaceOneAsync(IClientSessionHandle, FilterDefinition<TDocument>, TDocument, UpdateOptions, CancellationToken)

Replaces a single document.

[Obsolete("Use the overload that takes a ReplaceOptions instead of an UpdateOptions.")]
public virtual Task<ReplaceOneResult> ReplaceOneAsync(IClientSessionHandle session, FilterDefinition<TDocument> filter, TDocument replacement, UpdateOptions options, CancellationToken cancellationToken = default)

Parameters

session IClientSessionHandle: The session.
filter FilterDefinition<TDocument>: The filter.
replacement TDocument: The replacement.
options UpdateOptions: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

Task<ReplaceOneResult>: The result of the replacement.

UpdateMany(FilterDefinition<TDocument>, UpdateDefinition<TDocument>, UpdateOptions, CancellationToken)

Updates many documents.

public virtual UpdateResult UpdateMany(FilterDefinition<TDocument> filter, UpdateDefinition<TDocument> update, UpdateOptions options = null, CancellationToken cancellationToken = default)

Parameters

filter FilterDefinition<TDocument>: The filter.
update UpdateDefinition<TDocument>: The update.
options UpdateOptions: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

UpdateResult: The result of the update operation.

UpdateMany(IClientSessionHandle, FilterDefinition<TDocument>, UpdateDefinition<TDocument>, UpdateOptions, CancellationToken)

Updates many documents.

public virtual UpdateResult UpdateMany(IClientSessionHandle session, FilterDefinition<TDocument> filter, UpdateDefinition<TDocument> update, UpdateOptions options = null, CancellationToken cancellationToken = default)

Parameters

session IClientSessionHandle: The session.
filter FilterDefinition<TDocument>: The filter.
update UpdateDefinition<TDocument>: The update.
options UpdateOptions: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

UpdateResult: The result of the update operation.

UpdateManyAsync(FilterDefinition<TDocument>, UpdateDefinition<TDocument>, UpdateOptions, CancellationToken)

Updates many documents.

public virtual Task<UpdateResult> UpdateManyAsync(FilterDefinition<TDocument> filter, UpdateDefinition<TDocument> update, UpdateOptions options = null, CancellationToken cancellationToken = default)

Parameters

filter FilterDefinition<TDocument>: The filter.
update UpdateDefinition<TDocument>: The update.
options UpdateOptions: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

Task<UpdateResult>: The result of the update operation.

UpdateManyAsync(IClientSessionHandle, FilterDefinition<TDocument>, UpdateDefinition<TDocument>, UpdateOptions, CancellationToken)

Updates many documents.

public virtual Task<UpdateResult> UpdateManyAsync(IClientSessionHandle session, FilterDefinition<TDocument> filter, UpdateDefinition<TDocument> update, UpdateOptions options = null, CancellationToken cancellationToken = default)

Parameters

session IClientSessionHandle: The session.
filter FilterDefinition<TDocument>: The filter.
update UpdateDefinition<TDocument>: The update.
options UpdateOptions: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

Task<UpdateResult>: The result of the update operation.

UpdateOne(FilterDefinition<TDocument>, UpdateDefinition<TDocument>, UpdateOptions, CancellationToken)

Updates a single document.

public virtual UpdateResult UpdateOne(FilterDefinition<TDocument> filter, UpdateDefinition<TDocument> update, UpdateOptions options = null, CancellationToken cancellationToken = default)

Parameters

filter FilterDefinition<TDocument>: The filter.
update UpdateDefinition<TDocument>: The update.
options UpdateOptions: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

UpdateResult: The result of the update operation.

UpdateOne(IClientSessionHandle, FilterDefinition<TDocument>, UpdateDefinition<TDocument>, UpdateOptions, CancellationToken)

Updates a single document.

public virtual UpdateResult UpdateOne(IClientSessionHandle session, FilterDefinition<TDocument> filter, UpdateDefinition<TDocument> update, UpdateOptions options = null, CancellationToken cancellationToken = default)

Parameters

session IClientSessionHandle: The session.
filter FilterDefinition<TDocument>: The filter.
update UpdateDefinition<TDocument>: The update.
options UpdateOptions: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

UpdateResult: The result of the update operation.

UpdateOneAsync(FilterDefinition<TDocument>, UpdateDefinition<TDocument>, UpdateOptions, CancellationToken)

Updates a single document.

public virtual Task<UpdateResult> UpdateOneAsync(FilterDefinition<TDocument> filter, UpdateDefinition<TDocument> update, UpdateOptions options = null, CancellationToken cancellationToken = default)

Parameters

filter FilterDefinition<TDocument>: The filter.
update UpdateDefinition<TDocument>: The update.
options UpdateOptions: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

Task<UpdateResult>: The result of the update operation.

UpdateOneAsync(IClientSessionHandle, FilterDefinition<TDocument>, UpdateDefinition<TDocument>, UpdateOptions, CancellationToken)

Updates a single document.

public virtual Task<UpdateResult> UpdateOneAsync(IClientSessionHandle session, FilterDefinition<TDocument> filter, UpdateDefinition<TDocument> update, UpdateOptions options = null, CancellationToken cancellationToken = default)

Parameters

session IClientSessionHandle: The session.
filter FilterDefinition<TDocument>: The filter.
update UpdateDefinition<TDocument>: The update.
options UpdateOptions: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

Task<UpdateResult>: The result of the update operation.

WatchAsync<TResult>(IClientSessionHandle, PipelineDefinition<ChangeStreamDocument<TDocument>, TResult>, ChangeStreamOptions, CancellationToken)

Watches changes on the collection.

public virtual Task<IChangeStreamCursor<TResult>> WatchAsync<TResult>(IClientSessionHandle session, PipelineDefinition<ChangeStreamDocument<TDocument>, TResult> pipeline, ChangeStreamOptions options = null, CancellationToken cancellationToken = default)

Parameters

session IClientSessionHandle: The session.
pipeline PipelineDefinition<ChangeStreamDocument<TDocument>, TResult>: The pipeline.
options ChangeStreamOptions: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

Task<IChangeStreamCursor<TResult>>: A change stream.

Type Parameters

TResult: The type of the result.

WatchAsync<TResult>(PipelineDefinition<ChangeStreamDocument<TDocument>, TResult>, ChangeStreamOptions, CancellationToken)

Watches changes on the collection.

public virtual Task<IChangeStreamCursor<TResult>> WatchAsync<TResult>(PipelineDefinition<ChangeStreamDocument<TDocument>, TResult> pipeline, ChangeStreamOptions options = null, CancellationToken cancellationToken = default)

Parameters

pipeline PipelineDefinition<ChangeStreamDocument<TDocument>, TResult>: The pipeline.
options ChangeStreamOptions: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

Task<IChangeStreamCursor<TResult>>: A change stream.

Type Parameters

TResult: The type of the result.

Watch<TResult>(IClientSessionHandle, PipelineDefinition<ChangeStreamDocument<TDocument>, TResult>, ChangeStreamOptions, CancellationToken)

Watches changes on the collection.

public virtual IChangeStreamCursor<TResult> Watch<TResult>(IClientSessionHandle session, PipelineDefinition<ChangeStreamDocument<TDocument>, TResult> pipeline, ChangeStreamOptions options = null, CancellationToken cancellationToken = default)

Parameters

session IClientSessionHandle: The session.
pipeline PipelineDefinition<ChangeStreamDocument<TDocument>, TResult>: The pipeline.
options ChangeStreamOptions: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

IChangeStreamCursor<TResult>: A change stream.

Type Parameters

TResult: The type of the result.

Watch<TResult>(PipelineDefinition<ChangeStreamDocument<TDocument>, TResult>, ChangeStreamOptions, CancellationToken)

Watches changes on the collection.

public virtual IChangeStreamCursor<TResult> Watch<TResult>(PipelineDefinition<ChangeStreamDocument<TDocument>, TResult> pipeline, ChangeStreamOptions options = null, CancellationToken cancellationToken = default)

Parameters

pipeline PipelineDefinition<ChangeStreamDocument<TDocument>, TResult>: The pipeline.
options ChangeStreamOptions: The options.
cancellationToken CancellationToken: The cancellation token.

Returns

IChangeStreamCursor<TResult>: A change stream.

Type Parameters

TResult: The type of the result.

WithReadConcern(ReadConcern)

Returns a new IMongoCollection instance with a different read concern setting.

public virtual IMongoCollection<TDocument> WithReadConcern(ReadConcern readConcern)

Parameters

readConcern ReadConcern: The read concern.

Returns

IMongoCollection<TDocument>: A new IMongoCollection instance with a different read concern setting.

WithReadPreference(ReadPreference)

Returns a new IMongoCollection instance with a different read preference setting.

public abstract IMongoCollection<TDocument> WithReadPreference(ReadPreference readPreference)

Parameters

readPreference ReadPreference: The read preference.

Returns

IMongoCollection<TDocument>: A new IMongoCollection instance with a different read preference setting.

WithWriteConcern(WriteConcern)

Returns a new IMongoCollection instance with a different write concern setting.

public abstract IMongoCollection<TDocument> WithWriteConcern(WriteConcern writeConcern)

Parameters

writeConcern WriteConcern: The write concern.

Returns

IMongoCollection<TDocument>: A new IMongoCollection instance with a different write concern setting.

Table of Contents

Class MongoCollectionBase<TDocument>

Type Parameters

Properties

CollectionNamespace

Property Value

Database

Property Value

DocumentSerializer

Property Value

Indexes

Property Value

SearchIndexes

Property Value

Settings

Property Value

Methods

AggregateAsync<TResult>(IClientSessionHandle, PipelineDefinition<TDocument, TResult>, AggregateOptions, CancellationToken)

Parameters

Returns

Type Parameters

AggregateAsync<TResult>(PipelineDefinition<TDocument, TResult>, AggregateOptions, CancellationToken)

Parameters

Returns

Type Parameters

AggregateToCollectionAsync<TResult>(IClientSessionHandle, PipelineDefinition<TDocument, TResult>, AggregateOptions, CancellationToken)

Parameters

Returns

Type Parameters

AggregateToCollectionAsync<TResult>(PipelineDefinition<TDocument, TResult>, AggregateOptions, CancellationToken)

Parameters

Returns

Type Parameters

AggregateToCollection<TResult>(IClientSessionHandle, PipelineDefinition<TDocument, TResult>, AggregateOptions, CancellationToken)

Parameters

Type Parameters

AggregateToCollection<TResult>(PipelineDefinition<TDocument, TResult>, AggregateOptions, CancellationToken)

Parameters

Type Parameters

Aggregate<TResult>(IClientSessionHandle, PipelineDefinition<TDocument, TResult>, AggregateOptions, CancellationToken)

Parameters

Returns

Type Parameters

Aggregate<TResult>(PipelineDefinition<TDocument, TResult>, AggregateOptions, CancellationToken)

Parameters

Returns

Type Parameters

BulkWrite(IClientSessionHandle, IEnumerable<WriteModel<TDocument>>, BulkWriteOptions, CancellationToken)

Parameters

Returns

BulkWrite(IEnumerable<WriteModel<TDocument>>, BulkWriteOptions, CancellationToken)

Parameters

Returns

BulkWriteAsync(IClientSessionHandle, IEnumerable<WriteModel<TDocument>>, BulkWriteOptions, CancellationToken)

Parameters

Returns

BulkWriteAsync(IEnumerable<WriteModel<TDocument>>, BulkWriteOptions, CancellationToken)

Parameters

Returns

Count(FilterDefinition<TDocument>, CountOptions, CancellationToken)

Parameters

Returns

Count(IClientSessionHandle, FilterDefinition<TDocument>, CountOptions, CancellationToken)

Parameters

Returns

CountAsync(FilterDefinition<TDocument>, CountOptions, CancellationToken)

Parameters

Returns

CountAsync(IClientSessionHandle, FilterDefinition<TDocument>, CountOptions, CancellationToken)

Parameters

Returns

CountDocuments(FilterDefinition<TDocument>, CountOptions, CancellationToken)

Parameters

Returns

Remarks

CountDocuments(IClientSessionHandle, FilterDefinition<TDocument>, CountOptions, CancellationToken)

Parameters

Returns

Remarks

CountDocumentsAsync(FilterDefinition<TDocument>, CountOptions, CancellationToken)