Firestore API - Class ExplainOptions (3.10.0)

public sealed class ExplainOptions

Reference documentation and code samples for the Firestore API class ExplainOptions.

Options for query explanations.

Inheritance

object > ExplainOptions

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Firestore

Assembly

Google.Cloud.Firestore.dll

Properties

Analyze

public bool Analyze { get; }

Whether to execute this query.

When false (the default), the query will be planned, returning only metrics from the planning stages.

When true, the query will be planned and executed, returning the full query results along with both planning and execution stage metrics.

Property Value
Type	Description
`bool`

PlanAndExecute

public static ExplainOptions PlanAndExecute { get; }

Options to plan and execute a query.

Property Value
Type	Description
`ExplainOptions`

PlanOnly

public static ExplainOptions PlanOnly { get; }

Options that only plan a query, without executing it.

Property Value
Type	Description
`ExplainOptions`

Methods

FromProto(ExplainOptions)

public static ExplainOptions FromProto(ExplainOptions proto)

Creates a new instance based on the Protobuf Google.Cloud.Firestore.V1.ExplainOptions representation. Later modifications to the Protobuf representation will not affect the returned oject.

Parameter
Name	Description
`proto`	`Google.Cloud.Firestore.V1.ExplainOptions` The underlying Protobuf representation. Must not be null.

Returns
Type	Description
`ExplainOptions`	A new instance wrapping a clone of the protobuf message.

ToProto()

public ExplainOptions ToProto()

Creates a Protobuf Google.Cloud.Firestore.V1.ExplainOptions representation of this set of options. Modifications to the returned message will not be reflected in this object.

Returns
Type	Description
`Google.Cloud.Firestore.V1.ExplainOptions`	A Protobuf representation.