Interface IChangeStreamOperation<TResult>

Namespace

MongoDB.Driver.Core.Operations

Assembly

MongoDB.Driver.Core.dll

A change stream operation.

public interface IChangeStreamOperation<TResult> : IReadOperation<IChangeStreamCursor<TResult>>

Type Parameters

TResult

The type of the result.

Inherited Members

IReadOperation<IChangeStreamCursor<TResult>>.Execute(IReadBinding, CancellationToken)

IReadOperation<IChangeStreamCursor<TResult>>.ExecuteAsync(IReadBinding, CancellationToken)

Extension Methods

OperationExtensionMethods.ExecuteAsync<TResult>(IReadOperation<TResult>, IChannelSourceHandle, ReadPreference, ICoreSessionHandle, CancellationToken)

OperationExtensionMethods.Execute<TResult>(IReadOperation<TResult>, IChannelSourceHandle, ReadPreference, ICoreSessionHandle, CancellationToken)

Properties

ResumeAfter

Gets or sets the resume after value.

BsonDocument ResumeAfter { get; set; }

Property Value

BsonDocument

The resume after value.

ShowExpandedEvents

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

bool? ShowExpandedEvents { get; set; }

Property Value

bool?

The value.

StartAfter

Gets or sets the start after value.

BsonDocument StartAfter { get; set; }

Property Value

BsonDocument

The start after value.

StartAtOperationTime

Gets or sets the start at operation time.

BsonTimestamp StartAtOperationTime { get; set; }

Property Value

BsonTimestamp

The start at operation time.

Methods

Resume(IReadBinding, CancellationToken)

Resumes the operation after a resume token.

IAsyncCursor<RawBsonDocument> Resume(IReadBinding binding, CancellationToken cancellationToken)

Parameters

binding IReadBinding

The binding.

cancellationToken CancellationToken

The cancellation token.

Returns

IAsyncCursor<RawBsonDocument>

A cursor.

ResumeAsync(IReadBinding, CancellationToken)

Resumes the operation after a resume token.

Task<IAsyncCursor<RawBsonDocument>> ResumeAsync(IReadBinding binding, CancellationToken cancellationToken)

Parameters

binding IReadBinding

The binding.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<IAsyncCursor<RawBsonDocument>>

A Task whose result is a cursor.