ExplainOperation Class

Represents an explain operation.

Inheritance Hierarchy

SystemObject
MongoDB.Driver.Core.OperationsExplainOperation

Namespace: MongoDB.Driver.Core.Operations
Assembly: MongoDB.Driver.Core (in MongoDB.Driver.Core.dll) Version: 2.8.0+cc573f3e1f48f39162b4b680e921a623e127e8fa

Syntax

Copy

public class ExplainOperation : IReadOperation<BsonDocument>, 
	IWriteOperation<BsonDocument>

Public Class ExplainOperation
	Implements IReadOperation(Of BsonDocument), IWriteOperation(Of BsonDocument)

type ExplainOperation =  
    class
        interface IReadOperation<BsonDocument>
        interface IWriteOperation<BsonDocument>
    end

The ExplainOperation type exposes the following members.

Constructors

	Name	Description
	ExplainOperation	Initializes a new instance of the ExplainOperation class.

Top

Properties

	Name	Description
	Command	Gets the command to be explained.
	DatabaseNamespace	Gets the database namespace.
	MessageEncoderSettings	Gets the message encoder settings.
	Verbosity	Gets or sets the verbosity.

Top

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Execute(IReadBinding, CancellationToken)	Executes the operation.
	Execute(IWriteBinding, CancellationToken)	Executes the operation.
	ExecuteAsync(IReadBinding, CancellationToken)	Executes the operation.
	ExecuteAsync(IWriteBinding, CancellationToken)	Executes the operation.
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	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
	ExecuteBsonDocument(IChannelSourceHandle, ICoreSessionHandle, CancellationToken)	Overloaded. Executes a write operation using a channel source. (Defined by OperationExtensionMethods.)
	ExecuteBsonDocument(IChannelSourceHandle, ReadPreference, ICoreSessionHandle, CancellationToken)	Overloaded. Executes a read operation using a channel source. (Defined by OperationExtensionMethods.)
	ExecuteAsyncBsonDocument(IChannelSourceHandle, ICoreSessionHandle, CancellationToken)	Overloaded. Executes a write operation using a channel source. (Defined by OperationExtensionMethods.)
	ExecuteAsyncBsonDocument(IChannelSourceHandle, ReadPreference, ICoreSessionHandle, CancellationToken)	Overloaded. Executes a read operation using a channel source. (Defined by OperationExtensionMethods.)
	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.Operations Namespace