Cloud Firestore V1 Client - Class QueryPlan (1.45.0)

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