Class QueryMessage

Namespace

MongoDB.Driver.Core.WireProtocol.Messages

Assembly

MongoDB.Driver.Core.dll

Represents a Query message.

public class QueryMessage : RequestMessage, IEncodableMessage

Inheritance

object

MongoDBMessage

RequestMessage

QueryMessage

Implements

IEncodableMessage

Inherited Members

RequestMessage.CurrentGlobalRequestId

RequestMessage.GetNextRequestId()

RequestMessage.RequestId

RequestMessage.ShouldBeSent

RequestMessage.WasSent

MongoDBMessage.MayBeCompressed

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

QueryMessage(int, CollectionNamespace, BsonDocument, BsonDocument, IElementNameValidator, int, int, bool, bool, bool, bool, bool, bool, Func<bool>)

Initializes a new instance of the QueryMessage class.

[Obsolete("Use a constructor that does not have an oplogReplay parameter instead.")]
public QueryMessage(int requestId, CollectionNamespace collectionNamespace, BsonDocument query, BsonDocument fields, IElementNameValidator queryValidator, int skip, int batchSize, bool secondaryOk, bool partialOk, bool noCursorTimeout, bool oplogReplay, bool tailableCursor, bool awaitData, Func<bool> shouldBeSent = null)

Parameters

requestId int

The request identifier.

collectionNamespace CollectionNamespace

The collection namespace.

query BsonDocument

The query.

fields BsonDocument

The fields.

queryValidator IElementNameValidator

The query validator.

skip int

The number of documents to skip.

batchSize int

The size of a batch.

secondaryOk bool

if set to true it is OK if the server is not the primary.

partialOk bool

if set to true the server is allowed to return partial results if any shards are unavailable.

noCursorTimeout bool

if set to true the server should not timeout the cursor.

oplogReplay bool

if set to true the OplogReplay bit will be set.

tailableCursor bool

if set to true the query should return a tailable cursor.

awaitData bool

if set to true the server should await data (used with tailable cursors).

shouldBeSent Func<bool>

A delegate that determines whether this message should be sent.

QueryMessage(int, CollectionNamespace, BsonDocument, BsonDocument, IElementNameValidator, int, int, bool, bool, bool, bool, bool, Func<bool>)

Initializes a new instance of the QueryMessage class.

public QueryMessage(int requestId, CollectionNamespace collectionNamespace, BsonDocument query, BsonDocument fields, IElementNameValidator queryValidator, int skip, int batchSize, bool secondaryOk, bool partialOk, bool noCursorTimeout, bool tailableCursor, bool awaitData, Func<bool> shouldBeSent = null)

Parameters

requestId int

The request identifier.

collectionNamespace CollectionNamespace

The collection namespace.

query BsonDocument

The query.

fields BsonDocument

The fields.

queryValidator IElementNameValidator

The query validator.

skip int

The number of documents to skip.

batchSize int

The size of a batch.

secondaryOk bool

if set to true it is OK if the server is not the primary.

partialOk bool

if set to true the server is allowed to return partial results if any shards are unavailable.

noCursorTimeout bool

if set to true the server should not timeout the cursor.

tailableCursor bool

if set to true the query should return a tailable cursor.

awaitData bool

if set to true the server should await data (used with tailable cursors).

shouldBeSent Func<bool>

A delegate that determines whether this message should be sent.

Properties

AwaitData

Gets a value indicating whether the server should await data (used with tailable cursors).

public bool AwaitData { get; }

Property Value

bool

BatchSize

Gets the size of a batch.

public int BatchSize { get; }

Property Value

int

CollectionNamespace

Gets the collection namespace.

public CollectionNamespace CollectionNamespace { get; }

Property Value

CollectionNamespace

Fields

Gets the fields.

public BsonDocument Fields { get; }

Property Value

BsonDocument

MessageType

Gets the type of the message.

public override MongoDBMessageType MessageType { get; }

Property Value

MongoDBMessageType

NoCursorTimeout

Gets a value indicating whether the server should not timeout the cursor.

public bool NoCursorTimeout { get; }

Property Value

bool

OplogReplay

Gets a value indicating whether the OplogReplay bit will be set.

[Obsolete("OplogReplay is ignored by server versions 4.4.0 and newer.")]
public bool OplogReplay { get; }

Property Value

bool

true if the OplogReplay bit will be set; otherwise, false.

PartialOk

Gets a value indicating whether the server is allowed to return partial results if any shards are unavailable.

public bool PartialOk { get; }

Property Value

bool

PostWriteAction

Gets or sets the delegate called to after the message has been written by the encoder.

public Action<IMessageEncoderPostProcessor> PostWriteAction { get; set; }

Property Value

Action<IMessageEncoderPostProcessor>

The post write delegate.

Query

Gets the query.

public BsonDocument Query { get; }

Property Value

BsonDocument

QueryValidator

Gets the query validator.

public IElementNameValidator QueryValidator { get; }

Property Value

IElementNameValidator

ResponseHandling

Gets or sets the response handling.

public CommandResponseHandling ResponseHandling { get; set; }

Property Value

CommandResponseHandling

The response handling.

SecondaryOk

Gets a value indicating whether it is OK if the server is not the primary.

public bool SecondaryOk { get; }

Property Value

bool

Skip

Gets the number of documents to skip.

public int Skip { get; }

Property Value

int

TailableCursor

Gets a value indicating whether the query should return a tailable cursor.

public bool TailableCursor { get; }

Property Value

bool

Methods

GetEncoder(IMessageEncoderFactory)

Gets an encoder for the message from an encoder factory.

public override IMessageEncoder GetEncoder(IMessageEncoderFactory encoderFactory)

Parameters

encoderFactory IMessageEncoderFactory

The encoder factory.

Returns

IMessageEncoder

A message encoder.