Generated from protobuf messagegoogle.firestore.v1.PartitionQueryRequest
Namespace
Google \ Cloud \ Firestore \ V1
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:projects/{project_id}/databases/{database_id}/documents. Document resource names are not supported; only database resource names can be specified.
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
Thenext_page_tokenvalue 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 topartition_count. For example, ifpartition_count= 10 andpage_size= 8, the first call to PartitionQuery will return up to 8 partitions and anext_page_tokenif more results exist. A second call to PartitionQuery will return up to 2 partitions, to complete the total of 10 specified inpartition_count.
Reads documents as they were at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.
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.
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.
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
Thenext_page_tokenvalue 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
Thenext_page_tokenvalue 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 topartition_count.
For example, ifpartition_count= 10 andpage_size= 8, the first call
to PartitionQuery will return up to 8 partitions and anext_page_tokenif more results exist. A second call to PartitionQuery will return up to
2 partitions, to complete the total of 10 specified inpartition_count.
Returns
Type
Description
int
setPageSize
The maximum number of partitions to return in this call, subject topartition_count.
For example, ifpartition_count= 10 andpage_size= 8, the first call
to PartitionQuery will return up to 8 partitions and anext_page_tokenif more results exist. A second call to PartitionQuery will return up to
2 partitions, to complete the total of 10 specified inpartition_count.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getReadTime
Reads documents as they were at the given time.
This must be a microsecond precision timestamp within the past one hour,
or if Point-in-Time Recovery is enabled, can additionally be a whole
minute timestamp within the past 7 days.
This must be a microsecond precision timestamp within the past one hour,
or if Point-in-Time Recovery is enabled, can additionally be a whole
minute timestamp within the past 7 days.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Cloud Firestore V1 Client - Class PartitionQueryRequest (1.53.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.53.0 (latest)](/php/docs/reference/cloud-firestore/latest/V1.PartitionQueryRequest)\n- [1.52.0](/php/docs/reference/cloud-firestore/1.52.0/V1.PartitionQueryRequest)\n- [1.51.0](/php/docs/reference/cloud-firestore/1.51.0/V1.PartitionQueryRequest)\n- [1.50.0](/php/docs/reference/cloud-firestore/1.50.0/V1.PartitionQueryRequest)\n- [1.48.1](/php/docs/reference/cloud-firestore/1.48.1/V1.PartitionQueryRequest)\n- [1.47.3](/php/docs/reference/cloud-firestore/1.47.3/V1.PartitionQueryRequest)\n- [1.46.0](/php/docs/reference/cloud-firestore/1.46.0/V1.PartitionQueryRequest)\n- [1.45.2](/php/docs/reference/cloud-firestore/1.45.2/V1.PartitionQueryRequest)\n- [1.44.1](/php/docs/reference/cloud-firestore/1.44.1/V1.PartitionQueryRequest)\n- [1.43.3](/php/docs/reference/cloud-firestore/1.43.3/V1.PartitionQueryRequest)\n- [1.40.0](/php/docs/reference/cloud-firestore/1.40.0/V1.PartitionQueryRequest)\n- [1.39.0](/php/docs/reference/cloud-firestore/1.39.0/V1.PartitionQueryRequest)\n- [1.38.0](/php/docs/reference/cloud-firestore/1.38.0/V1.PartitionQueryRequest)\n- [1.37.7](/php/docs/reference/cloud-firestore/1.37.7/V1.PartitionQueryRequest)\n- [1.36.1](/php/docs/reference/cloud-firestore/1.36.1/V1.PartitionQueryRequest)\n- [1.35.0](/php/docs/reference/cloud-firestore/1.35.0/V1.PartitionQueryRequest)\n- [1.34.0](/php/docs/reference/cloud-firestore/1.34.0/V1.PartitionQueryRequest)\n- [1.33.0](/php/docs/reference/cloud-firestore/1.33.0/V1.PartitionQueryRequest)\n- [1.32.0](/php/docs/reference/cloud-firestore/1.32.0/V1.PartitionQueryRequest)\n- [1.31.0](/php/docs/reference/cloud-firestore/1.31.0/V1.PartitionQueryRequest)\n- [1.30.0](/php/docs/reference/cloud-firestore/1.30.0/V1.PartitionQueryRequest)\n- [1.28.0](/php/docs/reference/cloud-firestore/1.28.0/V1.PartitionQueryRequest)\n- [1.27.3](/php/docs/reference/cloud-firestore/1.27.3/V1.PartitionQueryRequest) \nReference documentation and code samples for the Cloud Firestore V1 Client class PartitionQueryRequest.\n\nThe request for\n[Firestore.PartitionQuery](/php/docs/reference/cloud-firestore/latest/V1.FirestoreClient#_Google_Cloud_Firestore_V1_FirestoreClient__partitionQuery__).\n\nGenerated from protobuf message `google.firestore.v1.PartitionQueryRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Firestore \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getParent\n\nRequired. The parent resource name. In the format:\n`projects/{project_id}/databases/{database_id}/documents`.\n\nDocument resource names are not supported; only database resource names\ncan be specified.\n\n### setParent\n\nRequired. The parent resource name. In the format:\n`projects/{project_id}/databases/{database_id}/documents`.\n\nDocument resource names are not supported; only database resource names\ncan be specified.\n\n### getStructuredQuery\n\nA structured query.\n\nQuery must specify collection with all descendants and be ordered by name\nascending. Other filters, order bys, limits, offsets, and start/end\ncursors are not supported.\n\n### hasStructuredQuery\n\n### setStructuredQuery\n\nA structured query.\n\nQuery must specify collection with all descendants and be ordered by name\nascending. Other filters, order bys, limits, offsets, and start/end\ncursors are not supported.\n\n### getPartitionCount\n\nThe desired maximum number of partition points.\n\nThe partitions may be returned across multiple pages of results.\nThe number must be positive. The actual number of partitions\nreturned may be fewer.\nFor example, this may be set to one fewer than the number of parallel\nqueries to be run, or in running a data pipeline job, one fewer than the\nnumber of workers or compute instances available.\n\n### setPartitionCount\n\nThe desired maximum number of partition points.\n\nThe partitions may be returned across multiple pages of results.\nThe number must be positive. The actual number of partitions\nreturned may be fewer.\nFor example, this may be set to one fewer than the number of parallel\nqueries to be run, or in running a data pipeline job, one fewer than the\nnumber of workers or compute instances available.\n\n### getPageToken\n\nThe `next_page_token` value returned from a previous call to\nPartitionQuery that may be used to get an additional set of results.\n\nThere are no ordering guarantees between sets of results. Thus, using\nmultiple sets of results will require merging the different result sets.\nFor example, two subsequent calls using a page_token may return:\n\n- cursor B, cursor M, cursor Q\n- 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\n\n### setPageToken\n\nThe `next_page_token` value returned from a previous call to\nPartitionQuery that may be used to get an additional set of results.\n\nThere are no ordering guarantees between sets of results. Thus, using\nmultiple sets of results will require merging the different result sets.\nFor example, two subsequent calls using a page_token may return:\n\n- cursor B, cursor M, cursor Q\n- 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\n\n### getPageSize\n\nThe maximum number of partitions to return in this call, subject to\n`partition_count`.\n\nFor example, if `partition_count` = 10 and `page_size` = 8, the first call\nto PartitionQuery will return up to 8 partitions and a `next_page_token`\nif more results exist. A second call to PartitionQuery will return up to\n2 partitions, to complete the total of 10 specified in `partition_count`.\n\n### setPageSize\n\nThe maximum number of partitions to return in this call, subject to\n`partition_count`.\n\nFor example, if `partition_count` = 10 and `page_size` = 8, the first call\nto PartitionQuery will return up to 8 partitions and a `next_page_token`\nif more results exist. A second call to PartitionQuery will return up to\n2 partitions, to complete the total of 10 specified in `partition_count`.\n\n### getReadTime\n\nReads documents as they were at the given time.\n\nThis must be a microsecond precision timestamp within the past one hour,\nor if Point-in-Time Recovery is enabled, can additionally be a whole\nminute timestamp within the past 7 days.\n\n### hasReadTime\n\n### setReadTime\n\nReads documents as they were at the given time.\n\nThis must be a microsecond precision timestamp within the past one hour,\nor if Point-in-Time Recovery is enabled, can additionally be a whole\nminute timestamp within the past 7 days.\n\n### getQueryType\n\n### getConsistencySelector"]]
