Reference documentation and code samples for the Cloud Firestore V1 Client class PartitionQueryRequest.
The request for Firestore.PartitionQuery .
Generated from protobuf message google.firestore.v1.PartitionQueryRequest
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. The parent resource name. In the format: projects/{project_id}/databases/{database_id}/documents
. Document resource names are not supported; only database resource names can be specified.
↳ structured_query
Google\Cloud\Firestore\V1\StructuredQuery
A structured query. Query must specify collection with all descendants and be ordered by name ascending. Other filters, order bys, limits, offsets, and start/end cursors are not supported.
↳ partition_count
int|string
The desired maximum number of partition points. The partitions may be returned across multiple pages of results. The number must be positive. The actual number of partitions returned may be fewer. For example, this may be set to one fewer than the number of parallel queries to be run, or in running a data pipeline job, one fewer than the number of workers or compute instances available.
↳ page_token
string
The next_page_token
value returned from a previous call to PartitionQuery that may be used to get an additional set of results. There are no ordering guarantees between sets of results. Thus, using multiple sets of results will require merging the different result sets. For example, two subsequent calls using a page_token may return: * cursor B, cursor M, cursor Q * cursor A, cursor U, cursor W To obtain a complete result set ordered with respect to the results of the query supplied to PartitionQuery, the results sets should be merged: cursor A, cursor B, cursor M, cursor Q, cursor U, cursor W
↳ page_size
int
The maximum number of partitions to return in this call, subject to partition_count
. For example, if partition_count
= 10 and page_size
= 8, the first call to PartitionQuery will return up to 8 partitions and a next_page_token
if more results exist. A second call to PartitionQuery will return up to 2 partitions, to complete the total of 10 specified in partition_count
.
↳ read_time
Google\Protobuf\Timestamp
Reads documents as they were at the given time. This may not be older than 270 seconds.
getParent
Required. The parent resource name. In the format: projects/{project_id}/databases/{database_id}/documents
.
Document resource names are not supported; only database resource names can be specified.
string
setParent
Required. The parent resource name. In the format: projects/{project_id}/databases/{database_id}/documents
.
Document resource names are not supported; only database resource names can be specified.
var
string
$this
getStructuredQuery
A structured query.
Query must specify collection with all descendants and be ordered by name ascending. Other filters, order bys, limits, offsets, and start/end cursors are not supported.
hasStructuredQuery
setStructuredQuery
A structured query.
Query must specify collection with all descendants and be ordered by name ascending. Other filters, order bys, limits, offsets, and start/end cursors are not supported.
$this
getPartitionCount
The desired maximum number of partition points.
The partitions may be returned across multiple pages of results. The number must be positive. The actual number of partitions returned may be fewer. For example, this may be set to one fewer than the number of parallel queries to be run, or in running a data pipeline job, one fewer than the number of workers or compute instances available.
int|string
setPartitionCount
The desired maximum number of partition points.
The partitions may be returned across multiple pages of results. The number must be positive. The actual number of partitions returned may be fewer. For example, this may be set to one fewer than the number of parallel queries to be run, or in running a data pipeline job, one fewer than the number of workers or compute instances available.
var
int|string
$this
getPageToken
The next_page_token
value returned from a previous call to
PartitionQuery that may be used to get an additional set of results.
There are no ordering guarantees between sets of results. Thus, using multiple sets of results will require merging the different result sets. For example, two subsequent calls using a page_token may return:
- cursor B, cursor M, cursor Q
- cursor A, cursor U, cursor W To obtain a complete result set ordered with respect to the results of the query supplied to PartitionQuery, the results sets should be merged: cursor A, cursor B, cursor M, cursor Q, cursor U, cursor W
string
setPageToken
The next_page_token
value returned from a previous call to
PartitionQuery that may be used to get an additional set of results.
There are no ordering guarantees between sets of results. Thus, using multiple sets of results will require merging the different result sets. For example, two subsequent calls using a page_token may return:
- cursor B, cursor M, cursor Q
- cursor A, cursor U, cursor W To obtain a complete result set ordered with respect to the results of the query supplied to PartitionQuery, the results sets should be merged: cursor A, cursor B, cursor M, cursor Q, cursor U, cursor W
var
string
$this
getPageSize
The maximum number of partitions to return in this call, subject to partition_count
.
For example, if partition_count
= 10 and page_size
= 8, the first call
to PartitionQuery will return up to 8 partitions and a next_page_token
if more results exist. A second call to PartitionQuery will return up to
2 partitions, to complete the total of 10 specified in partition_count
.
int
setPageSize
The maximum number of partitions to return in this call, subject to partition_count
.
For example, if partition_count
= 10 and page_size
= 8, the first call
to PartitionQuery will return up to 8 partitions and a next_page_token
if more results exist. A second call to PartitionQuery will return up to
2 partitions, to complete the total of 10 specified in partition_count
.
var
int
$this
getReadTime
Reads documents as they were at the given time.
This may not be older than 270 seconds.
hasReadTime
setReadTime
Reads documents as they were at the given time.
This may not be older than 270 seconds.
$this
getQueryType
string
getConsistencySelector
string
