Cloud Firestore V1 Client - Class QueryPlan (1.40.0)

Version 1.40.0

• 1.43.3 (latest)
• 1.43.2
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.7
• 1.36.1
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.28.0
• 1.27.3

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

Plan for the query.

Generated from protobuf message google.firestore.v1.QueryPlan

Namespace

Google \ Cloud \ Firestore \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ plan_info	Google\Protobuf\Struct Planning phase information for the query. It will include: { "indexes_used": [ {"query_scope": "Collection", "properties": "(foo ASC, name ASC)"}, {"query_scope": "Collection", "properties": "(bar ASC, name ASC)"} ] }

getPlanInfo

Planning phase information for the query. It will include: { "indexes_used": [ {"query_scope": "Collection", "properties": "(foo ASC, name ASC)"}, {"query_scope": "Collection", "properties": "(bar ASC, name ASC)"} ] }

Returns
Type	Description
Google\Protobuf\Struct|null

hasPlanInfo

clearPlanInfo

setPlanInfo

Planning phase information for the query. It will include: { "indexes_used": [ {"query_scope": "Collection", "properties": "(foo ASC, name ASC)"}, {"query_scope": "Collection", "properties": "(bar ASC, name ASC)"} ] }

Parameter
Name	Description
var	Google\Protobuf\Struct

Returns
Type	Description
$this