Executa uma consulta.
Solicitação HTTP
POST https://firestore.googleapis.com/v1beta1/{parent=projects/*/databases/*/documents}:runQuery
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de caminho
Parâmetros | |
---|---|
parent |
Obrigatório. O nome do recurso pai. Use o formato: |
Corpo da solicitação
O corpo da solicitação contém dados com a seguinte estrutura:
Representação JSON |
---|
{ "explainOptions": { object ( |
Campos | |
---|---|
explainOptions |
Opcional. Explique as opções para a consulta. Se definido, outras estatísticas de consulta serão retornadas. Caso contrário, apenas os resultados da consulta serão retornados. |
Campo de união query_type . A consulta a ser executada. query_type pode ser apenas de um dos tipos a seguir: |
|
structuredQuery |
Uma consulta estruturada. |
Campo de união consistency_selector . O modo de consistência para esta transação. Se não for definido, o padrão é a consistência forte. consistency_selector pode ser apenas de um dos tipos a seguir: |
|
transaction |
Execute a consulta em uma transação já ativa. O valor aqui é o ID da transação opaco em que a consulta será executada. Uma string codificada em base64. |
newTransaction |
Inicia uma nova transação e lê os documentos. O padrão é uma transação somente leitura. O novo ID da transação vai ser retornado como a primeira resposta no fluxo. |
readTime |
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: |
Corpo da resposta
A resposta para Firestore.RunQuery
.
Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:
Representação JSON |
---|
{ "transaction": string, "document": { object ( |
Campos | |
---|---|
transaction |
A transação que foi iniciada como parte desta solicitação. Só pode ser definido na primeira resposta e apenas se Uma string codificada em base64. |
document |
Um resultado de consulta, não definido ao relatar progresso parcial. |
readTime |
A hora em que o documento foi lido. Isso pode aumentar de forma monotônica. Nesse caso, é garantido que os documentos anteriores no fluxo de resultado não mudaram entre o Se a consulta não retornar resultados, uma resposta com Um carimbo de data/hora no formato UTC "Zulu" RFC3339, com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: |
skippedResults |
O número de resultados que foram ignorados devido a um deslocamento entre a última resposta e a atual. |
explainMetrics |
Métricas de explicação de consulta. Ele só está presente quando o |
Campo de união continuation_selector . O modo de continuação da consulta. Se estiver presente, ele indica que o fluxo de resposta da consulta atual foi concluído. Pode ser definido com ou sem um document presente, mas, quando definido, nenhum outro resultado é retornado. continuation_selector pode ser apenas de um dos tipos a seguir: |
|
done |
Se presente, o Firestore concluiu completamente a solicitação e nenhum outro documento será retornado. |
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.