Reference documentation and code samples for the Cloud Firestore V1 Client class ResultSetStats.
Planning and execution statistics for the query.
Generated from protobuf message google.firestore.v1.ResultSetStats
Namespace
Google \ Cloud \ Firestore \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ query_plan |
Google\Cloud\Firestore\V1\QueryPlan
Plan for the query. |
↳ query_stats |
Google\Protobuf\Struct
Aggregated statistics from the execution of the query. This will only be present when the request specifies |
getQueryPlan
Plan for the query.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Firestore\V1\QueryPlan|null | |
hasQueryPlan
clearQueryPlan
setQueryPlan
Plan for the query.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Firestore\V1\QueryPlan
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getQueryStats
Aggregated statistics from the execution of the query.
This will only be present when the request specifies PROFILE mode.
For example, a query will return the statistics including:
{
"results_returned": "20",
"documents_scanned": "20",
"indexes_entries_scanned": "10050",
"total_execution_time": "100.7 msecs"
}
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Struct|null | |
hasQueryStats
clearQueryStats
setQueryStats
Aggregated statistics from the execution of the query.
This will only be present when the request specifies PROFILE mode.
For example, a query will return the statistics including:
{
"results_returned": "20",
"documents_scanned": "20",
"indexes_entries_scanned": "10050",
"total_execution_time": "100.7 msecs"
}
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Struct
|
| Returns | |
|---|---|
| Type | Description |
$this | |