QueryMessage Class

Represents a Query message.

Inheritance Hierarchy

SystemObject
  MongoDB.Driver.Core.WireProtocol.MessagesMongoDBMessage
    MongoDB.Driver.Core.WireProtocol.MessagesRequestMessage
      MongoDB.Driver.Core.WireProtocol.MessagesQueryMessage

Namespace: MongoDB.Driver.Core.WireProtocol.Messages
Assembly: MongoDB.Driver.Core (in MongoDB.Driver.Core.dll) Version: 2.21.0+5a9c3311e158910b88195f290e6d4b1b2715d2b2

Syntax

Copy

public class QueryMessage : RequestMessage

Public Class QueryMessage
	Inherits RequestMessage

type QueryMessage =  
    class
        inherit RequestMessage
    end

The QueryMessage type exposes the following members.

Constructors

	Name	Description
	QueryMessage(Int32, CollectionNamespace, BsonDocument, BsonDocument, IElementNameValidator, Int32, Int32, Boolean, Boolean, Boolean, Boolean, Boolean, FuncBoolean)	Initializes a new instance of the QueryMessage class.
	QueryMessage(Int32, CollectionNamespace, BsonDocument, BsonDocument, IElementNameValidator, Int32, Int32, Boolean, Boolean, Boolean, Boolean, Boolean, Boolean, FuncBoolean)	Obsolete. Initializes a new instance of the QueryMessage class.

Top

Properties

	Name	Description
	AwaitData	Gets a value indicating whether the server should await data (used with tailable cursors).
	BatchSize	Gets the size of a batch.
	CollectionNamespace	Gets the collection namespace.
	Fields	Gets the fields.
	MayBeCompressed	Gets the flag whether the message may be compressed or not. (Inherited from MongoDBMessage.)
	MessageType	Gets the type of the message. (Overrides MongoDBMessageMessageType.)
	NoCursorTimeout	Gets a value indicating whether the server should not timeout the cursor.
	OplogReplay	Obsolete. Gets a value indicating whether the OplogReplay bit will be set.
	PartialOk	Gets a value indicating whether the server is allowed to return partial results if any shards are unavailable.
	PostWriteAction	Gets or sets the delegate called to after the message has been written by the encoder.
	Query	Gets the query.
	QueryValidator	Gets the query validator.
	RequestId	Gets the request identifier. (Inherited from RequestMessage.)
	ResponseHandling	Gets or sets the response handling.
	SecondaryOk	Gets a value indicating whether it is OK if the server is not the primary.
	ShouldBeSent	Gets a delegate that determines whether this message should be sent. (Inherited from RequestMessage.)
	Skip	Gets the number of documents to skip.
	TailableCursor	Gets a value indicating whether the query should return a tailable cursor.
	WasSent	Gets or sets a value indicating whether this message was sent. (Inherited from RequestMessage.)

Top

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetEncoder	Gets an encoder for the message from an encoder factory. (Overrides MongoDBMessageGetEncoder(IMessageEncoderFactory).)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Extension Methods

	Name	Description
	ToBson	Serializes an object to a BSON byte array. (Defined by BsonExtensionMethods.)
	ToBsonDocument	Serializes an object to a BsonDocument. (Defined by BsonExtensionMethods.)
	ToJson	Serializes an object to a JSON string. (Defined by BsonExtensionMethods.)

Top

Reference

MongoDB.Driver.Core.WireProtocol.Messages Namespace