Cloud Datastore V1 Client - Class RunQueryResponse (1.26.0)

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 \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
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 GqlQuery from the request, if it was set.

↳ 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 NORMAL.

getBatch

A batch of query results (always present).

Returns
TypeDescription
Google\Cloud\Datastore\V1\QueryResultBatch|null

hasBatch

clearBatch

setBatch

A batch of query results (always present).

Parameter
NameDescription
var Google\Cloud\Datastore\V1\QueryResultBatch
Returns
TypeDescription
$this

getQuery

The parsed form of the GqlQuery from the request, if it was set.

Returns
TypeDescription
Google\Cloud\Datastore\V1\Query|null

hasQuery

clearQuery

setQuery

The parsed form of the GqlQuery from the request, if it was set.

Parameter
NameDescription
var Google\Cloud\Datastore\V1\Query
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var Google\Cloud\Datastore\V1\ResultSetStats
Returns
TypeDescription
$this