GoogleApi.Firestore.V1.Model.PartitionQueryRequest (google_api_firestore v0.21.3) View Source

The request for Firestore.PartitionQuery.


  • pageSize (type: integer(), default: nil) - 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.
  • pageToken (type: String.t, default: nil) - 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
  • partitionCount (type: String.t, default: nil) - 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.
  • structuredQuery (type: GoogleApi.Firestore.V1.Model.StructuredQuery.t, default: nil) - 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.

Link to this section Summary


Unwrap a decoded JSON object into its complex fields.

Link to this section Types


t() :: %GoogleApi.Firestore.V1.Model.PartitionQueryRequest{
  pageSize: integer() | nil,
  pageToken: String.t() | nil,
  partitionCount: String.t() | nil,
  structuredQuery: GoogleApi.Firestore.V1.Model.StructuredQuery.t() | nil

Link to this section Functions


decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.