Reference documentation and code samples for the Cloud Datastore V1 Client class QueryResultBatch.
A batch of results produced by a query.
Generated from protobuf message google.datastore.v1.QueryResultBatch
Namespace
Google \ Cloud \ Datastore \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ skipped_results
int
The number of results skipped, typically because of an offset.
↳ skipped_cursor
string
A cursor that points to the position after the last skipped result. Will be set when skipped_results
!= 0.
↳ entity_result_type
int
The result type for every entity in entity_results
.
↳ entity_results
↳ end_cursor
string
A cursor that points to the position after the last result in the batch.
↳ more_results
int
The state of the query after the current batch.
↳ snapshot_version
int|string
The version number of the snapshot this batch was returned from. This applies to the range of results from the query's start_cursor
(or the beginning of the query if no cursor was given) to this batch's end_cursor
(not the query's end_cursor
). In a single transaction, subsequent query result batches for the same query can have a greater snapshot version number. Each batch's snapshot version is valid for all preceding batches. The value will be zero for eventually consistent queries.
↳ read_time
Google\Protobuf\Timestamp
Read timestamp this batch was returned from. This applies to the range of results from the query's start_cursor
(or the beginning of the query if no cursor was given) to this batch's end_cursor
(not the query's end_cursor
). In a single transaction, subsequent query result batches for the same query can have a greater timestamp. Each batch's read timestamp is valid for all preceding batches. This value will not be set for eventually consistent queries in Cloud Datastore.
getSkippedResults
The number of results skipped, typically because of an offset.
int
setSkippedResults
The number of results skipped, typically because of an offset.
var
int
$this
getSkippedCursor
A cursor that points to the position after the last skipped result.
Will be set when skipped_results
!= 0.
string
setSkippedCursor
A cursor that points to the position after the last skipped result.
Will be set when skipped_results
!= 0.
var
string
$this
getEntityResultType
The result type for every entity in entity_results
.
int
setEntityResultType
The result type for every entity in entity_results
.
var
int
$this
getEntityResults
The results for this batch.
setEntityResults
The results for this batch.
$this
getEndCursor
A cursor that points to the position after the last result in the batch.
string
setEndCursor
A cursor that points to the position after the last result in the batch.
var
string
$this
getMoreResults
The state of the query after the current batch.
int
setMoreResults
The state of the query after the current batch.
var
int
$this
getSnapshotVersion
The version number of the snapshot this batch was returned from.
This applies to the range of results from the query's start_cursor
(or
the beginning of the query if no cursor was given) to this batch's end_cursor
(not the query's end_cursor
).
In a single transaction, subsequent query result batches for the same query
can have a greater snapshot version number. Each batch's snapshot version
is valid for all preceding batches.
The value will be zero for eventually consistent queries.
int|string
setSnapshotVersion
The version number of the snapshot this batch was returned from.
This applies to the range of results from the query's start_cursor
(or
the beginning of the query if no cursor was given) to this batch's end_cursor
(not the query's end_cursor
).
In a single transaction, subsequent query result batches for the same query
can have a greater snapshot version number. Each batch's snapshot version
is valid for all preceding batches.
The value will be zero for eventually consistent queries.
var
int|string
$this
getReadTime
Read timestamp this batch was returned from.
This applies to the range of results from the query's start_cursor
(or
the beginning of the query if no cursor was given) to this batch's end_cursor
(not the query's end_cursor
).
In a single transaction, subsequent query result batches for the same query
can have a greater timestamp. Each batch's read timestamp
is valid for all preceding batches.
This value will not be set for eventually consistent queries in Cloud
Datastore.
hasReadTime
clearReadTime
setReadTime
Read timestamp this batch was returned from.
This applies to the range of results from the query's start_cursor
(or
the beginning of the query if no cursor was given) to this batch's end_cursor
(not the query's end_cursor
).
In a single transaction, subsequent query result batches for the same query
can have a greater timestamp. Each batch's read timestamp
is valid for all preceding batches.
This value will not be set for eventually consistent queries in Cloud
Datastore.
$this
