MongoDB .NET Driver API Documentation

Namespaces

MongoDB.Driver

AggregateArgs Class

AggregateBucketAutoGranularity Structure

AggregateBucketAutoOptions Class

AggregateBucketAutoResult(TValue) Class

AggregateBucketAutoResultId(TValue) Class

AggregateBucketAutoResultIdSerializer Class

AggregateBucketAutoResultIdSerializer(TValue) Class

AggregateBucketOptions(TValue) Class

AggregateBucketResult(TValue) Class

AggregateCountResult Class

AggregateExpressionDefinition(TSource, TResult) Class

AggregateFacet Class

AggregateFacet(TInput) Class

AggregateFacet(TInput, TOutput) Class

AggregateFacetOptions(TOutput) Class

AggregateFacetResult Class

AggregateFacetResult(TOutput) Class

AggregateFacetResults Class

AggregateFluentBase(TResult) Class

AggregateGraphLookupOptions(TFrom, TAsElement, TOutput) Class

AggregateLookupOptions(TForeignDocument, TResult) Class

AggregateOptions Class

AggregateOutputMode Enumeration

AggregateSortByCountResult(TId) Class

AggregateStringTranslationMode Enumeration

AggregateUnwindOptions(TResult) Class

AppendedStagePipelineDefinition(TInput, TIntermediate, TOutput) Class

ArrayFilterDefinition Class

ArrayFilterDefinition(TItem) Class

BatchTransformingAsyncCursor(TFromDocument, TToDocument) Class

BsonDocumentArrayFilterDefinition(TItem) Class

BsonDocumentCommand(TResult) Class

BsonDocumentFilterDefinition(TDocument) Class

BsonDocumentIndexKeysDefinition(TDocument) Class

BsonDocumentPipelineStageDefinition(TInput, TOutput) Class

BsonDocumentProjectionDefinition(TSource) Class

BsonDocumentProjectionDefinition(TSource, TProjection) Class

BsonDocumentSortDefinition(TDocument) Class

BsonDocumentStagePipelineDefinition(TInput, TOutput) Class

BsonDocumentUpdateDefinition(TDocument) Class

BsonValueAggregateExpressionDefinition(TSource, TResult) Class

Builders(TDocument) Class

BulkUpdateRequestBuilder(TDocument) Class

BulkWriteError Class

BulkWriteOperation(TDocument) Class

BulkWriteOptions Class

BulkWriteRequestBuilder(TDocument) Class

BulkWriteResult Class

BulkWriteResult(TDocument) Class

BulkWriteResult(TDocument).Acknowledged Class

BulkWriteResult(TDocument).Unacknowledged Class

BulkWriteUpsert Class

ChangeStreamDocument(TDocument) Class

ChangeStreamDocumentSerializer(TDocument) Class

ChangeStreamFullDocumentBeforeChangeOption Enumeration

ChangeStreamFullDocumentOption Enumeration

ChangeStreamOperationType Enumeration

ChangeStreamOperationTypeSerializer Class

ChangeStreamOptions Class

ChangeStreamPreAndPostImagesOptions Class

ChangeStreamStageOptions Class

ChangeStreamUpdateDescription Class

ChangeStreamUpdateDescriptionSerializer Class

ClientSessionOptions Class

ClientSideDeserializationProjectionDefinition(TSource, TProjection) Class

ClusteredIndexOptions(TDocument) Class

ClusterRegistry Class

Collation Class

CollationAlternate Enumeration

CollationCaseFirst Enumeration

CollationMaxVariable Enumeration

CollationStrength Enumeration

CollectionNamespace Class

CollectionOptionsDocument Class

CollectionStatsResult Class

CollectionStatsResult.IndexSizesResult Class

CollectionSystemFlags Enumeration

CollectionUserFlags Enumeration

Command(TResult) Class

CommandDocument Class

CommandResult Class

CommandResultSerializer(TCommandResult) Class

ConnectionMode Enumeration

ConstantSetFieldDefinition(TDocument, TField) Class

CountArgs Class

CountOptions Class

CreateCollectionOptions Class

CreateCollectionOptions(TDocument) Class

CreateIndexCommitQuorum Class

CreateIndexCommitQuorumWithMode Class

CreateIndexCommitQuorumWithW Class

CreateIndexModel(TDocument) Class

CreateIndexOptions Class

CreateIndexOptions(TDocument) Class

CreateManyIndexesOptions Class

CreateOneIndexOptions Class

CreateSearchIndexModel Class

CreateViewOptions(TDocument) Class

CreateViewOptionsDocument Class

CursorType Enumeration

DatabaseNamespace Class

DatabaseStatsResult Class

DeferredAsyncCursor(TDocument) Class

DeleteManyModel(TDocument) Class

DeleteOneModel(TDocument) Class

DeleteOptions Class

DeleteResult Class

DeleteResult.Acknowledged Class

DeleteResult.Unacknowledged Class

DensifyBounds Class

DensifyDateTimeBounds Class

DensifyDateTimeRange Class

DensifyDateTimeUnit Enumeration

DensifyKeywordDateTimeBounds Class

DensifyKeywordNumericBounds(TNumber) Class

DensifyLowerUpperDateTimeBounds Class

DensifyLowerUpperNumericBounds(TNumber) Class

DensifyNumericBounds(TNumber) Class

DensifyNumericRange(TNumber) Class

DensifyRange Class

DistinctArgs Class

DistinctOptions Class

DocumentsAggregateExpressionDefinition(TDocument) Class

DocumentsWindow Class

DocumentsWindowBoundary Class

DocumentValidationAction Enumeration

DocumentValidationLevel Enumeration

DropCollectionOptions Class

DropIndexOptions Class

EmptyPipelineDefinition(TInput) Class

EstimatedDocumentCountOptions Class

EvalArgs Class

EvalFlags Enumeration

ExpressionAggregateExpressionDefinition(TSource, TResult) Class

ExpressionFieldDefinition(TDocument) Class

ExpressionFieldDefinition(TDocument, TField) Class

ExpressionFilterDefinition(TDocument) Class

ExpressionSetFieldDefinitions(TDocument, TFields) Class

ExpressionTranslationOptions Class

ExternalEvidence Class

FeatureId Enumeration

FieldDefinition(TDocument) Class

FieldDefinition(TDocument, TField) Class

FieldsDocument Class

FilterDefinition(TDocument) Class

FilterDefinitionBuilder(TDocument) Class

FindAndModifyArgs Class

FindAndModifyDocumentVersion Enumeration

FindAndModifyResult Class

FindAndRemoveArgs Class

FindExpressionProjectionDefinition(TSource, TProjection) Class

FindFluentBase(TDocument, TProjection) Class

FindOneAndDeleteOptions(TDocument) Class

FindOneAndDeleteOptions(TDocument, TProjection) Class

FindOneAndReplaceOptions(TDocument) Class

FindOneAndReplaceOptions(TDocument, TProjection) Class

FindOneAndUpdateOptions(TDocument) Class

FindOneAndUpdateOptions(TDocument, TProjection) Class

FindOneArgs Class

FindOptions Class

FindOptions(TDocument) Class

FindOptions(TDocument, TProjection) Class

FindOptionsBase Class

GeoHaystackSearchArgs Class

GeoHaystackSearchOptionsDocument Class

GeoHaystackSearchResult Class

GeoHaystackSearchResult.GeoHaystackSearchHit Class

GeoHaystackSearchResult.GeoHaystackSearchHits Class

GeoHaystackSearchResult.GeoHaystackSearchStats Class

GeoHaystackSearchResult(TDocument) Class

GeoHaystackSearchResult(TDocument).GeoHaystackSearchHit Class

GeoHaystackSearchResult(TDocument).GeoHaystackSearchHits Class

GeoNearArgs Class

GeoNearOptionsDocument Class

GeoNearPoint Class

GeoNearPoint.GeoJson(TCoordinates) Class

GeoNearPoint.Legacy Class

GeoNearResult Class

GeoNearResult.GeoNearHit Class

GeoNearResult.GeoNearHits Class

GeoNearResult.GeoNearStats Class

GeoNearResult(TDocument) Class

GeoNearResult(TDocument).GeoNearHit Class

GeoNearResult(TDocument).GeoNearHits Class

GetIndexesResult Class

GetProfilingLevelResult Class

GetStatsArgs Class

GroupArgs Class

GroupByDocument Class

IAggregateFluent(TResult) Interface

IAggregateFluentExtensions Class

IAsyncCursor(TDocument) Interface

IAsyncCursorExtensions Class

IAsyncCursorSource(TDocument) Interface

IAsyncCursorSourceExtensions Class

IChangeStreamCursor(TDocument) Interface

IClientSession Interface

IClientSessionHandle Interface

ICoreServerSession Interface

IFilteredMongoCollection(TDocument) Interface

IFindFluent(TDocument, TProjection) Interface

IFindFluentExtensions Class

IMongoClient Interface

IMongoClientExtensions Class

IMongoCollection(TDocument) Interface

IMongoCollectionExtensions Class

IMongoCollectionOptions Interface

IMongoCommand Interface

IMongoCreateViewOptions Interface

IMongoDatabase Interface

IMongoDatabaseExtensions Class

IMongoFields Interface

IMongoGeoHaystackSearchOptions Interface

IMongoGeoNearOptions Interface

IMongoGroupBy Interface

IMongoIndexKeys Interface

IMongoIndexManager(TDocument) Interface

IMongoIndexOptions Interface

IMongoQuery Interface

IMongoScope Interface

IMongoSortBy Interface

IMongoUpdate Interface

IndexInfo Class

IndexKeysDefinition(TDocument) Class

IndexKeysDefinitionBuilder(TDocument) Class

IndexKeysDefinitionExtensions Class

IndexKeysDocument Class

IndexOptionDefaults Class

IndexOptionsDocument Class

InsertFlags Enumeration

InsertManyOptions Class

InsertOneModel(TDocument) Class

InsertOneOptions Class

IOrderedAggregateFluent(TResult) Interface

IOrderedFindFluent(TDocument, TProjection) Interface

IPipelineStageDefinition Interface

IRenderedPipelineStageDefinition Interface

IServerSession Interface

ISetWindowFieldsPartition(TInput) Class

JsonArrayFilterDefinition(TItem) Class

JsonCommand(TResult) Class

JsonFilterDefinition(TDocument) Class

JsonIndexKeysDefinition(TDocument) Class

JsonPipelineStageDefinition(TInput, TOutput) Class

JsonProjectionDefinition(TSource) Class

JsonProjectionDefinition(TSource, TProjection) Class

JsonSortDefinition(TDocument) Class

JsonUpdateDefinition(TDocument) Class

KeywordDocumentsWindowBoundary Class

KeywordRangeWindowBoundary Class

ListCollectionNamesOptions Class

ListCollectionsOptions Class

ListDatabaseNamesOptions Class

ListDatabasesOptions Class

ListIndexesOptions Class

ListSetFieldDefinitions(TDocument) Class

ListSetFieldDefinitionsExtensions Class

MapReduceArgs Class

MapReduceOptions(TDocument, TResult) Class

MapReduceOutputMode Enumeration

MapReduceOutputOptions Class

MapReduceResult Class

MergeStageOptions(TOutput) Class

MergeStageWhenMatched Enumeration

MergeStageWhenNotMatched Enumeration

MongoAuthenticationException Class

MongoBulkWriteException Class

MongoBulkWriteException(TDocument) Class

MongoClient Class

MongoClientBase Class

MongoClientException Class

MongoClientExtensions Class

MongoClientSettings Class

MongoCollection Class

MongoCollection(TDefaultDocument) Class

MongoCollectionBase(TDocument) Class

MongoCollectionSettings Class

MongoCommandException Class

MongoConfigurationException Class

MongoConnectionClosedException Class

MongoConnectionException Class

MongoConnectionPoolPausedException Class

MongoCredential Class

MongoCursor Class

MongoCursor(TDocument) Class

MongoCursorNotFoundException Class

MongoDatabase Class

MongoDatabaseBase Class

MongoDatabaseSettings Class

MongoDBRef Class

MongoDBRefSerializer Class

MongoDefaults Class

MongoDuplicateKeyException Class

MongoException Class

MongoExecutionTimeoutException Class

MongoExternalAwsIdentity Class

MongoExternalIdentity Class

MongoIdentity Class

MongoIdentityEvidence Class

MongoIncompatibleDriverException Class

MongoIndexManagerBase(TDocument) Class

MongoInsertOptions Class

MongoInternalException Class

MongoInternalIdentity Class

MongoNodeIsRecoveringException Class

MongoNotPrimaryException Class

MongoQueryException Class

MongoServer Class

MongoServerAddress Class

MongoServerException Class

MongoServerInstance Class

MongoServerInstanceType Enumeration

MongoServerSettings Class

MongoServerState Enumeration

MongoUpdateOptions Class

MongoUrl Class

MongoUrlBuilder Class

MongoUrlTypeConverter Class

MongoUser Class

MongoUtils Class

MongoWaitQueueFullException Class

MongoWriteConcernException Class

MongoWriteException Class

MongoX509Identity Class

NoPipelineInput Class

ObjectCommand(TResult) Class

ObjectFilterDefinition(TDocument) Class

ObjectProjectionDefinition(TSource) Class

ObjectProjectionDefinition(TSource, TProjection) Class

ObjectSortDefinition(TDocument) Class

ObjectUpdateDefinition(TDocument) Class

Optional Class

Optional(T) Structure

ParallelScanArgs Class

ParallelScanArgs(TDocument) Class

PasswordEvidence Class

PipelineDefinition(TInput, TOutput) Class

PipelineDefinitionBuilder Class

PipelineStageDefinition(TInput, TOutput) Class

PipelineStageDefinitionBuilder Class

PipelineStagePipelineDefinition(TInput, TOutput) Class

PipelineUpdateDefinition(TDocument) Class

PositionDocumentsWindowBoundary Class

PrependedStagePipelineDefinition(TInput, TIntermediate, TOutput) Class

ProfilingLevel Enumeration

ProjectionDefinition(TSource) Class

ProjectionDefinition(TSource, TProjection) Class

ProjectionDefinitionBuilder(TSource) Class

ProjectionDefinitionExtensions Class

QueryDocument Class

QueryFlags Enumeration

QueryVector Class

RangeWindow Class

RangeWindowBoundary Class

ReadConcern Class

ReadConcernLevel Enumeration

ReadPreference Class

ReadPreferenceHedge Class

ReadPreferenceMode Enumeration

RemoveArgs Class

RemoveFlags Enumeration

RenameCollectionOptions Class

RenderedCommand(TResult) Class

RenderedFieldDefinition Class

RenderedFieldDefinition(TField) Class

RenderedPipelineDefinition(TOutput) Class

RenderedPipelineStageDefinition(TOutput) Class

RenderedProjectionDefinition(TProjection) Class

ReplaceOneModel(TDocument) Class

ReplaceOneResult Class

ReplaceOneResult.Acknowledged Class

ReplaceOneResult.Unacknowledged Class

ReplaceOptions Class

ReplaceOutputSerializerPipelineDefinition(TInput, TIntermediate, TOutput) Class

ReturnDocument Enumeration

ScopeDocument Class

ServerApi Class

ServerApiVersion Class

ServerErrorCategory Enumeration

SetFieldDefinition(TDocument) Class

SetFieldDefinitions(TDocument) Class

SetFieldDefinitionsBuilder(TDocument) Class

Setting(T) Structure

SetWindowFieldsWindow Class

SortByDocument Class

SortDefinition(TDocument) Class

SortDefinitionBuilder(TDocument) Class

SortDefinitionExtensions Class

SortDirection Enumeration

SslSettings Class

StringFieldDefinition(TDocument) Class

StringFieldDefinition(TDocument, TField) Class

StringOrRegularExpression Class

SystemProfileInfo Class

SystemProfileInfoSerializer Class

SystemProfileLockStatistics Class

SystemProfileLockStatisticsSerializer Class

SystemProfileReadWriteLockStatistics Class

SystemProfileReadWriteLockStatisticsSerializer Class

Tag Class

TagSet Class

TextSearchOptions Class

TimeRangeWindowBoundary Class

TimeSeriesGranularity Enumeration

TimeSeriesOptions Class

TransactionOptions Class

UpdateDefinition(TDocument) Class

UpdateDefinitionBuilder(TDocument) Class

UpdateDefinitionCurrentDateType Enumeration

UpdateDefinitionExtensions Class

UpdateDocument Class

UpdateFlags Enumeration

UpdateManyModel(TDocument) Class

UpdateOneModel(TDocument) Class

UpdateOptions Class

UpdateResult Class

UpdateResult.Acknowledged Class

UpdateResult.Unacknowledged Class

ValidateCollectionArgs Class

ValidateCollectionResult Class

ValidateCollectionResult.ExtentDetails Class

ValueRangeWindowBoundary Class

ValueRangeWindowBoundary(TValue) Class

VectorSearchOptions(TDocument) Class

WriteConcern Class

WriteConcern.WCount Class

WriteConcern.WMode Class

WriteConcern.WValue Class

WriteConcernError Class

WriteConcernResult Class

WriteError Class

WriteModel(TDocument) Class

WriteModelType Enumeration

XYPoint Class

ChangeStreamFullDocumentBeforeChangeOption Enumeration

Change stream FullDocumentBeforeChange option.

Namespace: MongoDB.Driver
Assembly: MongoDB.Driver.Core (in MongoDB.Driver.Core.dll) Version: 2.22.0+75246110ed1247226fcc7f8eb2c54ffab745693e

Syntax

Copy

public enum ChangeStreamFullDocumentBeforeChangeOption

Public Enumeration ChangeStreamFullDocumentBeforeChangeOption

type ChangeStreamFullDocumentBeforeChangeOption

Members

Member name	Value	Description
Default	0	Do not send this option to the server. Server's default is to not return the full document before change.
Off	1	Do not return the full document before change.
WhenAvailable	2	Returns the pre-image of the modified document for replace, update and delete change events if the pre-image for this event is available.
Required	3	Same behavior as 'whenAvailable' except that an error is raised if the pre-image is not available.

Reference

MongoDB.Driver Namespace