Method: projects.databases.documents.partitionQuery

Particiona uma consulta retornando cursores de partição que podem ser usados para executar a consulta em paralelo. Os cursores de partição retornados são pontos de divisão que podem ser usados por documents.runQuery como pontos de início/término para os resultados da consulta.

Solicitação HTTP

POST https://firestore.googleapis.com/v1beta1/{parent=projects/*/databases/*/documents}:partitionQuery

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. O nome do recurso pai. Use o formato: projects/{projectId}/databases/{databaseId}/documents. Os nomes de recursos do documento não são aceitos. Só é possível especificar nomes de recursos de bancos de dados.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{
  "partitionCount": string,
  "pageToken": string,
  "pageSize": integer,

  // Union field query_type can be only one of the following:
  "structuredQuery": {
    object (StructuredQuery)
  }
  // End of list of possible types for union field query_type.

  // Union field consistency_selector can be only one of the following:
  "readTime": string
  // End of list of possible types for union field consistency_selector.
}
Campos
partitionCount

string (int64 format)

O número máximo desejado de pontos de partição. As partições podem ser retornadas em várias páginas de resultados. O número precisa ser positivo. O número real de partições retornadas pode ser menor.

Por exemplo, isso pode ser definido como uma quantidade a menos que o número de consultas paralelas a serem executadas ou, na execução de um job de pipeline de dados, um a menos que o número de workers ou instâncias de computação disponíveis.
pageToken

string

O valor nextPageToken retornado de uma chamada anterior para documents.partitionQuery que pode ser usado para receber mais um conjunto de resultados. Não há garantias de ordenação entre conjuntos de resultados. Portanto, o uso de vários conjuntos de resultados exigirá a mesclagem de diferentes conjuntos de resultados.

Por exemplo, duas chamadas subsequentes usando um pageToken podem retornar:

  • cursor B, cursor M, cursor Q
  • cursor A, cursor U, cursor W

Para receber um conjunto de resultados completo ordenado com relação aos resultados da consulta fornecidos a documents.partitionQuery, os conjuntos de resultados precisam ser mesclados: cursor A, cursor B, cursor M, cursor Q, cursor U, cursor W
pageSize

integer

O número máximo de partições a serem retornadas nesta chamada, sujeito a partitionCount.

Por exemplo, se partitionCount = 10 e pageSize = 8, a primeira chamada para documents.partitionQuery retorna até oito partições e uma nextPageToken se houver mais resultados. Uma segunda chamada para documents.partitionQuery retorna até duas partições, para completar o total de 10 especificadas em partitionCount.
Campo de união query_type. A consulta a ser particionada. query_type pode ser apenas de um dos tipos a seguir:
structuredQuery

object (StructuredQuery)

Uma consulta estruturada. A consulta precisa especificar a coleção com todos os descendentes e ser ordenada por nome em ordem crescente. Outros filtros, itens de ordenação, limites, deslocamentos e cursores de início/término não são compatíveis.
Campo de união consistency_selector. O modo de consistência para essa solicitação. Se não for definido, o padrão é a consistência forte. consistency_selector pode ser apenas de um dos tipos a seguir:
readTime

string (Timestamp format)

Lê os documentos como estavam na época.

Precisa ser um carimbo de data/hora com precisão de microssegundos dentro da última hora ou, se a recuperação pontual estiver ativada, também pode ser um carimbo de data/hora de um minuto inteiro nos últimos sete dias.

Um carimbo de data/hora no formato UTC "Zulu" RFC3339, com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

Corpo da resposta

A resposta para Firestore.PartitionQuery.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "partitions": [
    {
      object (Cursor)
    }
  ],
  "nextPageToken": string
}
Campos
partitions[]

object (Cursor)

Resultados da partição. Cada partição é um ponto de divisão que pode ser usado por documents.runQuery como um ponto inicial ou final para os resultados da consulta. As solicitações de documents.runQuery precisam ser feitas com a mesma consulta fornecida a essa solicitação de documents.partitionQuery. Os cursores de partição serão ordenados de acordo com a mesma ordem dos resultados da consulta fornecida para documents.partitionQuery.

Por exemplo, se uma solicitação Docs.partitionQuery retorna os cursores de partição A e B, a execução das três consultas a seguir retorna todo o conjunto de resultados da consulta original:

  • consulta, endAt A
  • consulta, startAt A, endAt B
  • consulta, startAt B

Um resultado vazio pode indicar que a consulta tem poucos resultados para ser particionada ou que ela ainda não é compatível com particionamento.
nextPageToken

string

Um token de página que pode ser usado para solicitar um conjunto adicional de resultados, até o número especificado por partitionCount na solicitação Docs.partitionQuery. Se o campo ficar em branco, não haverá mais resultados.

Escopos de autorização

Requer um dos seguintes escopos de OAuth:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Para saber mais, consulte a Visão geral da autenticação.