Firestore v1 API - Class ExplainOptions (3.8.0) 

public sealed class ExplainOptions : IMessage<ExplainOptions>, IEquatable<ExplainOptions>, IDeepCloneable<ExplainOptions>, IBufferMessage, IMessage

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

Explain options for the query.

Inheritance

object > ExplainOptions

Namespace

Google.Cloud.Firestore.V1

Assembly

Google.Cloud.Firestore.V1.dll

Constructors

ExplainOptions()

public ExplainOptions()

ExplainOptions(ExplainOptions)

public ExplainOptions(ExplainOptions other)
Parameter
Name Description
other ExplainOptions

Properties

Analyze

public bool Analyze { get; set; }

Optional. 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