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.
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
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.
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.
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.
public StructuredQuery StructuredQuery { get; set; }
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[[["\u003cp\u003eThe latest version of the \u003ccode\u003ePartitionQueryRequest\u003c/code\u003e class is 3.10.0, part of the Google.Cloud.Firestore.V1 namespace.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003ePartitionQueryRequest\u003c/code\u003e is used for Firestore's \u003ccode\u003ePartitionQuery\u003c/code\u003e and implements interfaces such as \u003ccode\u003eIMessage\u003c/code\u003e, \u003ccode\u003eIEquatable\u003c/code\u003e, \u003ccode\u003eIDeepCloneable\u003c/code\u003e, \u003ccode\u003eIBufferMessage\u003c/code\u003e, and \u003ccode\u003eIPageRequest\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe class includes properties like \u003ccode\u003ePageSize\u003c/code\u003e, \u003ccode\u003ePageToken\u003c/code\u003e, \u003ccode\u003eParent\u003c/code\u003e, and \u003ccode\u003ePartitionCount\u003c/code\u003e to manage the partitioning and retrieval of data.\u003c/p\u003e\n"],["\u003cp\u003eIt also supports the retrieval of data at a specific point in time via the \u003ccode\u003eReadTime\u003c/code\u003e property and allows a structured query through the \u003ccode\u003eStructuredQuery\u003c/code\u003e property.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003ePartitionQueryRequest\u003c/code\u003e includes constructors to create an instance, either empty, or from another \u003ccode\u003ePartitionQueryRequest\u003c/code\u003e instance, to copy over existing values.\u003c/p\u003e\n"]]],[],null,["# Firestore v1 API - Class PartitionQueryRequest (3.10.0)\n\nVersion latestkeyboard_arrow_down\n\n- [3.10.0 (latest)](/dotnet/docs/reference/Google.Cloud.Firestore.V1/latest/Google.Cloud.Firestore.V1.PartitionQueryRequest)\n- [3.9.0](/dotnet/docs/reference/Google.Cloud.Firestore.V1/3.9.0/Google.Cloud.Firestore.V1.PartitionQueryRequest)\n- [3.8.0](/dotnet/docs/reference/Google.Cloud.Firestore.V1/3.8.0/Google.Cloud.Firestore.V1.PartitionQueryRequest)\n- [3.7.0](/dotnet/docs/reference/Google.Cloud.Firestore.V1/3.7.0/Google.Cloud.Firestore.V1.PartitionQueryRequest)\n- [3.6.0](/dotnet/docs/reference/Google.Cloud.Firestore.V1/3.6.0/Google.Cloud.Firestore.V1.PartitionQueryRequest)\n- [3.5.1](/dotnet/docs/reference/Google.Cloud.Firestore.V1/3.5.1/Google.Cloud.Firestore.V1.PartitionQueryRequest)\n- [3.4.0](/dotnet/docs/reference/Google.Cloud.Firestore.V1/3.4.0/Google.Cloud.Firestore.V1.PartitionQueryRequest)\n- [3.3.0](/dotnet/docs/reference/Google.Cloud.Firestore.V1/3.3.0/Google.Cloud.Firestore.V1.PartitionQueryRequest)\n- [3.2.0](/dotnet/docs/reference/Google.Cloud.Firestore.V1/3.2.0/Google.Cloud.Firestore.V1.PartitionQueryRequest)\n- [3.1.0](/dotnet/docs/reference/Google.Cloud.Firestore.V1/3.1.0/Google.Cloud.Firestore.V1.PartitionQueryRequest)\n- [3.0.0](/dotnet/docs/reference/Google.Cloud.Firestore.V1/3.0.0/Google.Cloud.Firestore.V1.PartitionQueryRequest)\n- [2.5.0](/dotnet/docs/reference/Google.Cloud.Firestore.V1/2.5.0/Google.Cloud.Firestore.V1.PartitionQueryRequest)\n- [2.4.0](/dotnet/docs/reference/Google.Cloud.Firestore.V1/2.4.0/Google.Cloud.Firestore.V1.PartitionQueryRequest)\n- [2.3.0](/dotnet/docs/reference/Google.Cloud.Firestore.V1/2.3.0/Google.Cloud.Firestore.V1.PartitionQueryRequest) \n\n public sealed class PartitionQueryRequest : IMessage\u003cPartitionQueryRequest\u003e, IEquatable\u003cPartitionQueryRequest\u003e, IDeepCloneable\u003cPartitionQueryRequest\u003e, IBufferMessage, IMessage, IPageRequest\n\nReference documentation and code samples for the Firestore v1 API class PartitionQueryRequest.\n\nThe request for\n\\[Firestore.PartitionQuery\\]\\[google.firestore.v1.Firestore.PartitionQuery\\]. \n\nInheritance\n-----------\n\n[object](https://learn.microsoft.com/dotnet/api/system.object) \\\u003e PartitionQueryRequest \n\nImplements\n----------\n\n[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[PartitionQueryRequest](/dotnet/docs/reference/Google.Cloud.Firestore.V1/latest/Google.Cloud.Firestore.V1.PartitionQueryRequest), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[PartitionQueryRequest](/dotnet/docs/reference/Google.Cloud.Firestore.V1/latest/Google.Cloud.Firestore.V1.PartitionQueryRequest), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[PartitionQueryRequest](/dotnet/docs/reference/Google.Cloud.Firestore.V1/latest/Google.Cloud.Firestore.V1.PartitionQueryRequest), [IBufferMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IBufferMessage.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage.html), [IPageRequest](https://cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.Grpc.IPageRequest.html) \n\nInherited Members\n-----------------\n\n[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) \n[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) \n[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)\n\nNamespace\n---------\n\n[Google.Cloud.Firestore.V1](/dotnet/docs/reference/Google.Cloud.Firestore.V1/latest/Google.Cloud.Firestore.V1)\n\nAssembly\n--------\n\nGoogle.Cloud.Firestore.V1.dll\n\nConstructors\n------------\n\n### PartitionQueryRequest()\n\n public PartitionQueryRequest()\n\n### PartitionQueryRequest(PartitionQueryRequest)\n\n public PartitionQueryRequest(PartitionQueryRequest other)\n\nProperties\n----------\n\n### ConsistencySelectorCase\n\n public PartitionQueryRequest.ConsistencySelectorOneofCase ConsistencySelectorCase { get; }\n\n### PageSize\n\n public int PageSize { get; set; }\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### PageToken\n\n public string PageToken { get; set; }\n\nThe `next_page_token` value returned from a previous call to\nPartitionQuery that may be used to get an additional set of results.\nThere are no ordering guarantees between sets of results. Thus, using\nmultiple sets of results will require merging the different result sets.\n\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\n\nTo obtain a complete result set ordered with respect to the results of the\nquery supplied to PartitionQuery, the results sets should be merged:\ncursor A, cursor B, cursor M, cursor Q, cursor U, cursor W\n\n### Parent\n\n public string Parent { get; set; }\n\nRequired. The parent resource name. In the format:\n`projects/{project_id}/databases/{database_id}/documents`.\nDocument resource names are not supported; only database resource names\ncan be specified.\n\n### PartitionCount\n\n public long PartitionCount { get; set; }\n\nThe desired maximum number of partition points.\nThe partitions may be returned across multiple pages of results.\nThe number must be positive. The actual number of partitions\nreturned may be fewer.\n\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### QueryTypeCase\n\n public PartitionQueryRequest.QueryTypeOneofCase QueryTypeCase { get; }\n\n### ReadTime\n\n public Timestamp ReadTime { get; set; }\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### StructuredQuery\n\n public StructuredQuery StructuredQuery { get; set; }\n\nA structured query.\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."]]
