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.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The parent resource name. In the format: |
↳ 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 |
↳ page_size |
int
The maximum number of partitions to return in this call, subject to |
↳ 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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Firestore\V1\StructuredQuery|null | |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Firestore\V1\StructuredQuery
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$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
| Returns | |
|---|---|
| Type | Description |
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
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getReadTime
Reads documents as they were at the given time.
This may not be older than 270 seconds.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasReadTime
setReadTime
Reads documents as they were at the given time.
This may not be older than 270 seconds.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getQueryType
| Returns | |
|---|---|
| Type | Description |
string | |
getConsistencySelector
| Returns | |
|---|---|
| Type | Description |
string | |