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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Cloud Firestore V1 Client - Class ExplainOptions (1.53.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.53.0 (latest)](/php/docs/reference/cloud-firestore/latest/V1.ExplainOptions)\n- [1.52.0](/php/docs/reference/cloud-firestore/1.52.0/V1.ExplainOptions)\n- [1.51.0](/php/docs/reference/cloud-firestore/1.51.0/V1.ExplainOptions)\n- [1.50.0](/php/docs/reference/cloud-firestore/1.50.0/V1.ExplainOptions)\n- [1.48.1](/php/docs/reference/cloud-firestore/1.48.1/V1.ExplainOptions)\n- [1.47.3](/php/docs/reference/cloud-firestore/1.47.3/V1.ExplainOptions)\n- [1.46.0](/php/docs/reference/cloud-firestore/1.46.0/V1.ExplainOptions)\n- [1.45.2](/php/docs/reference/cloud-firestore/1.45.2/V1.ExplainOptions)\n- [1.44.1](/php/docs/reference/cloud-firestore/1.44.1/V1.ExplainOptions)\n- [1.43.3](/php/docs/reference/cloud-firestore/1.43.3/V1.ExplainOptions)\n- [1.40.0](/php/docs/reference/cloud-firestore/1.40.0/V1.ExplainOptions)\n- [1.39.0](/php/docs/reference/cloud-firestore/1.39.0/V1.ExplainOptions)\n- [1.38.0](/php/docs/reference/cloud-firestore/1.38.0/V1.ExplainOptions)\n- [1.37.7](/php/docs/reference/cloud-firestore/1.37.7/V1.ExplainOptions)\n- [1.36.1](/php/docs/reference/cloud-firestore/1.36.1/V1.ExplainOptions)\n- [1.35.0](/php/docs/reference/cloud-firestore/1.35.0/V1.ExplainOptions)\n- [1.34.0](/php/docs/reference/cloud-firestore/1.34.0/V1.ExplainOptions)\n- [1.33.0](/php/docs/reference/cloud-firestore/1.33.0/V1.ExplainOptions)\n- [1.32.0](/php/docs/reference/cloud-firestore/1.32.0/V1.ExplainOptions)\n- [1.31.0](/php/docs/reference/cloud-firestore/1.31.0/V1.ExplainOptions)\n- [1.30.0](/php/docs/reference/cloud-firestore/1.30.0/V1.ExplainOptions)\n- [1.28.0](/php/docs/reference/cloud-firestore/1.28.0/V1.ExplainOptions)\n- [1.27.3](/php/docs/reference/cloud-firestore/1.27.3/V1.ExplainOptions) \nReference documentation and code samples for the Cloud Firestore V1 Client class ExplainOptions.\n\nExplain options for the query.\n\nGenerated from protobuf message `google.firestore.v1.ExplainOptions`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Firestore \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getAnalyze\n\nOptional. Whether to execute this query.\n\nWhen false (the default), the query will be planned, returning only\nmetrics from the planning stages.\nWhen true, the query will be planned and executed, returning the full\nquery results along with both planning and execution stage metrics.\n\n### setAnalyze\n\nOptional. Whether to execute this query.\n\nWhen false (the default), the query will be planned, returning only\nmetrics from the planning stages.\nWhen true, the query will be planned and executed, returning the full\nquery results along with both planning and execution stage metrics."]]
