Table of Contents

Class ChangeStreamOptions

Namespace
MongoDB.Driver
Assembly
MongoDB.Driver.dll

Options for a change stream operation.

public class ChangeStreamOptions
Inheritance
ChangeStreamOptions
Inherited Members

Properties

BatchSize

Gets or sets the size of the batch.

public int? BatchSize { get; set; }

Property Value

int?

The size of the batch.

Collation

Gets or sets the collation.

public Collation Collation { get; set; }

Property Value

Collation

The collation.

Comment

Gets or sets the comment.

public BsonValue Comment { get; set; }

Property Value

BsonValue

The comment.

FullDocument

Gets or sets the full document.

public ChangeStreamFullDocumentOption FullDocument { get; set; }

Property Value

ChangeStreamFullDocumentOption

The full document.

FullDocumentBeforeChange

Gets or sets the full document before change.

public ChangeStreamFullDocumentBeforeChangeOption FullDocumentBeforeChange { get; set; }

Property Value

ChangeStreamFullDocumentBeforeChangeOption

The full document before change.

MaxAwaitTime

Gets or sets the maximum await time.

public TimeSpan? MaxAwaitTime { get; set; }

Property Value

TimeSpan?

The maximum await time.

ResumeAfter

Gets or sets the resume after.

public BsonDocument ResumeAfter { get; set; }

Property Value

BsonDocument

The resume after.

ShowExpandedEvents

Gets or sets whether the change stream should show expanded events (MongoDB 6.0 and later). Expanded change stream events include:

public bool? ShowExpandedEvents { get; set; }

Property Value

bool?

The value.

StartAfter

Gets or sets the start after.

public BsonDocument StartAfter { get; set; }

Property Value

BsonDocument

The start after.

StartAtOperationTime

Gets or sets the start at operation time.

public BsonTimestamp StartAtOperationTime { get; set; }

Property Value

BsonTimestamp

The start at operation time.