Table of Contents

Struct CursorBatch<TDocument>

Namespace
MongoDB.Driver.Core.WireProtocol
Assembly
MongoDB.Driver.Core.dll

Represents one result batch (returned from either a Query or a GetMore message)

public struct CursorBatch<TDocument>

Type Parameters

TDocument

The type of the document.

Inherited Members

Constructors

CursorBatch(long, BsonDocument, IReadOnlyList<TDocument>)

Initializes a new instance of the CursorBatch<TDocument> struct.

public CursorBatch(long cursorId, BsonDocument postBatchResumeToken, IReadOnlyList<TDocument> documents)

Parameters

cursorId long

The cursor identifier.

postBatchResumeToken BsonDocument

The post batch resume token.

documents IReadOnlyList<TDocument>

The documents.

CursorBatch(long, IReadOnlyList<TDocument>)

Initializes a new instance of the CursorBatch<TDocument> struct.

public CursorBatch(long cursorId, IReadOnlyList<TDocument> documents)

Parameters

cursorId long

The cursor identifier.

documents IReadOnlyList<TDocument>

The documents.

Properties

CursorId

Gets the cursor identifier.

public long CursorId { get; }

Property Value

long

The cursor identifier.

Documents

Gets the documents.

public IReadOnlyList<TDocument> Documents { get; }

Property Value

IReadOnlyList<TDocument>

The documents.

PostBatchResumeToken

Gets the post batch resume token.

public BsonDocument PostBatchResumeToken { get; }

Property Value

BsonDocument

The post batch resume token.