Reference documentation and code samples for the Cloud Datastore V1 Client class RunQueryResponse.
The response for Datastore.RunQuery.
Generated from protobuf message google.datastore.v1.RunQueryResponse
Namespace
Google \ Cloud \ Datastore \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ batch |
Google\Cloud\Datastore\V1\QueryResultBatch
A batch of query results (always present). |
↳ query |
Google\Cloud\Datastore\V1\Query
The parsed form of the |
↳ transaction |
string
The identifier of the transaction that was started as part of this RunQuery request. Set only when ReadOptions.new_transaction was set in RunQueryRequest.read_options. |
↳ stats |
Google\Cloud\Datastore\V1\ResultSetStats
Query plan and execution statistics. Note that the returned stats are subject to change as Firestore evolves. This is only present when the request specifies a mode other than |
getBatch
A batch of query results (always present).
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Datastore\V1\QueryResultBatch|null |
|
hasBatch
clearBatch
setBatch
A batch of query results (always present).
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Datastore\V1\QueryResultBatch
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getQuery
The parsed form of the GqlQuery from the request, if it was set.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Datastore\V1\Query|null |
|
hasQuery
clearQuery
setQuery
The parsed form of the GqlQuery from the request, if it was set.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Datastore\V1\Query
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTransaction
The identifier of the transaction that was started as part of this RunQuery request.
Set only when ReadOptions.new_transaction was set in RunQueryRequest.read_options.
| Returns | |
|---|---|
| Type | Description |
string |
|
setTransaction
The identifier of the transaction that was started as part of this RunQuery request.
Set only when ReadOptions.new_transaction was set in RunQueryRequest.read_options.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStats
Query plan and execution statistics. Note that the returned stats are subject to change as Firestore evolves.
This is only present when the request specifies a mode other than NORMAL.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Datastore\V1\ResultSetStats|null |
|
hasStats
clearStats
setStats
Query plan and execution statistics. Note that the returned stats are subject to change as Firestore evolves.
This is only present when the request specifies a mode other than NORMAL.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Datastore\V1\ResultSetStats
|
| Returns | |
|---|---|
| Type | Description |
$this |
|