Cloud Firestore V1 Client - Class ExplainOptions (1.43.3)

Reference documentation and code samples for the Cloud Firestore V1 Client class ExplainOptions.

Explain options for the query.

Generated from protobuf message google.firestore.v1.ExplainOptions

Namespace

Google \ Cloud \ Firestore \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ analyze bool

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.

getAnalyze

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.

Returns
Type Description
bool

setAnalyze

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.

Parameter
Name Description
var bool
Returns
Type Description
$this