Package google.firestore.v1beta1

map<string, Value>

O resultado das funções de agregação, por exemplo: COUNT(*) AS total_docs.

A chave é o alias atribuído à função de agregação na entrada, e o tamanho desse mapa é igual ao número de funções de agregação na consulta.

Value

Valores na matriz.

string

Obrigatório. O nome do banco de dados. Use o formato: projects/{project_id}/databases/{database_id}.

string

Os nomes dos documentos a serem recuperados. Use o formato: projects/{project_id}/databases/{database_id}/documents/{document_path}. A solicitação falhará se algum dos documentos não for um recurso filho da database especificada. Nomes duplicados serão ocultados.

DocumentMask

Os campos a serem retornados. Se não for definido, todos os campos serão retornados.

Se um documento tiver um campo que não esteja presente nessa máscara, esse campo não será retornado na resposta.

bytes

Lê documentos em uma transação.

TransactionOptions

Inicia uma nova transação e lê os documentos. O padrão é uma transação somente leitura. O novo ID da transação será retornado como a primeira resposta no fluxo.

Timestamp

Lê os documentos como estavam no momento especificado.

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

bytes

A transação que foi iniciada como parte da solicitação. Será definido apenas na primeira resposta e somente se BatchGetDocumentsRequest.new_transaction tiver sido definido na solicitação.

Timestamp

A hora em que o documento foi lido. Isso pode ser monoticamente crescente. Neste caso, os documentos anteriores no fluxo de resultados têm a garantia de não terem sido alterados entre o read_time e este.

Document

Um documento que foi solicitado.

string

Um nome de documento que foi solicitado, mas não existe. Use o formato: projects/{project_id}/databases/{database_id}/documents/{document_path}.

string

Obrigatório. O nome do banco de dados. Use o formato: projects/{project_id}/databases/{database_id}.

Write

As gravações a serem aplicadas.

O método não aplica gravações atomicamente e não garante ordem. Cada gravação é bem-sucedida ou falha de maneira independente. Não é possível gravar no mesmo documento mais de uma vez por solicitação.

map<string, string>

Rótulos associados a essa gravação em lote.

WriteResult

O resultado da aplicação das gravações.

Esse i-ésimo resultado de gravação corresponde à i-ésima gravação na solicitação.

Status

O status da aplicação das gravações.

Esse status de i-ésima gravação corresponde à i-ésima gravação na solicitação.

string

Obrigatório. O nome do banco de dados. Use o formato: projects/{project_id}/databases/{database_id}.

TransactionOptions

As opções da transação. O padrão é uma transação de leitura e gravação.

bytes

A transação que foi iniciada.

bytes

Os bytes que codificam a sequência de bits. Pode ter um comprimento de zero.

int32

O número de bits do último byte em bitmap que será ignorado como "padding". Se o comprimento de bitmap for zero, esse valor precisará ser 0. Caso contrário, esse valor precisa estar entre 0 e 7.

BitSequence

Dados do filtro de flores.

int32

O número de hashes usados pelo algoritmo.

string

Obrigatório. O nome do banco de dados. Use o formato: projects/{project_id}/databases/{database_id}.

Write

As gravações a serem aplicadas.

Sempre executado atomicamente e em ordem.

bytes

Se definido, aplica todas as gravações nesta transação e confirma-as.

WriteResult

O resultado da aplicação das gravações.

Esse i-ésimo resultado de gravação corresponde à i-ésima gravação na solicitação.

Timestamp

O horário em que a confirmação ocorreu. Qualquer leitura com um read_time igual ou maior garante a visualização dos efeitos da confirmação.

string

Obrigatório. O recurso pai. Por exemplo: projects/{project_id}/databases/{database_id}/documents ou projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}

string

Obrigatório. O ID da coleção, relativo a parent, para a lista. Por exemplo, chatrooms.

string

O ID do documento atribuído pelo cliente para usar neste documento.

Opcional. Se não for especificado, um ID será atribuído pelo serviço.

Document

Obrigatório. O documento a ser criado. name não pode ser definido.

DocumentMask

Os campos a serem retornados. Se não for definido, todos os campos serão retornados.

Se o documento tiver um campo que não esteja presente na máscara, esse campo não será retornado na resposta.

Value

Os valores que representam uma posição, na ordem em que aparecem na ordem por cláusula de uma consulta.

Pode conter menos valores do que o especificado na ordem por cláusula.

bool

Se a posição estiver logo antes ou depois dos valores fornecidos, em relação à ordem de classificação definida pela consulta.

string

Obrigatório. O nome do recurso do documento a ser excluído. Use o formato: projects/{project_id}/databases/{database_id}/documents/{document_path}.

Precondition

Uma pré-condição opcional no documento. A solicitação falhará se esse valor for definido e não for atendido pelo documento de destino.

string

O nome de recurso do documento, por exemplo, projects/{project_id}/databases/{database_id}/documents/{document_path}.

map<string, Value>

Timestamp

Apenas saída. A hora em que o documento foi criado.

Esse valor aumenta monotonicamente quando um documento é excluído e recriado. Também pode ser comparado com valores de outros documentos e com o read_time de uma consulta.

Timestamp

Apenas saída. A hora em que o documento foi alterado pela última vez.

Inicialmente, esse valor é definido como create_time e aumenta monotonicamente a cada mudança no documento. Também pode ser comparado com valores de outros documentos e com o read_time de uma consulta.

Document

O novo estado da Document.

Se mask estiver definido, conterá apenas campos que foram atualizados ou adicionados.

int32

Um conjunto de IDs de destinos que correspondem a este documento.

int32

Um conjunto de IDs de destino para segmentações que não correspondem mais a este documento.

string

O nome do recurso do Document que foi excluído.

int32

Um conjunto de IDs de destino para destinos que corresponderam anteriormente a essa entidade.

Timestamp

Carimbo de data/hora de leitura em que a exclusão foi observada.

Maior ou igual ao commit_time da exclusão.

string

A lista de caminhos de campo na máscara. Consulte Document.fields para conferir uma referência de sintaxe de caminho do campo.

string

O nome do recurso do Document que saiu da área de visualização.

int32

Um conjunto de IDs de destino para destinos que corresponderam anteriormente a este documento.

Timestamp

Carimbo de data/hora de leitura em que a remoção foi observada.

Maior ou igual ao commit_time de alteração/exclusão/remoção.

string

O nome do documento a ser transformado.

FieldTransform

A lista de transformações a serem aplicadas aos campos do documento, em ordem. Este campo não pode ficar vazio.

string

O caminho do campo. Consulte Document.fields para conferir a referência de sintaxe do caminho do campo.

ServerValue

Define o campo para o valor do servidor especificado.

Value

Adiciona o valor informado ao valor atual do campo.

Precisa ser um número inteiro ou um valor duplo. Se o campo não for um número inteiro ou duplo, ou se o campo ainda não existir, a transformação definirá o campo com o valor fornecido. Se um dos valores fornecidos ou o valor do campo atual forem duplicados, ambos os valores serão interpretados como duplos. A aritmética dupla e a representação de valores duplos seguem a semântica IEEE 754. Se houver estouro de números inteiros positivos/negativos, o campo será resolvido para o número inteiro positivo/negativo de maior magnitude.

Value

Define o campo para o máximo de seu valor atual e o valor informado.

Precisa ser um número inteiro ou um valor duplo. Se o campo não for um número inteiro ou duplo, ou se o campo ainda não existir, a transformação definirá o campo com o valor fornecido. Se uma operação máxima for aplicada em que o campo e o valor de entrada forem de tipos mistos (ou seja, um é um número inteiro e outro é duplo), o campo assumirá o tipo do operando maior. Se os operandos forem equivalentes (por exemplo, 3 e 3.0), o campo não será alterado. 0, 0,0 e -0,0 são todos zero. O máximo de um valor armazenado em zero e um valor de entrada zero é sempre o valor armazenado. O máximo de qualquer valor numérico x e NaN é NaN.

Value

Define o campo para o mínimo de seu valor atual e o valor informado.

Precisa ser um número inteiro ou um valor duplo. Se o campo não for um número inteiro ou duplo, ou se o campo ainda não existir, a transformação definirá o campo como o valor de entrada. Se uma operação mínima for aplicada em que o campo e o valor de entrada forem de tipos mistos (ou seja, um é um número inteiro e outro é duplo), o campo assumirá o tipo do operando menor. Se os operandos forem equivalentes (por exemplo, 3 e 3.0), o campo não será alterado. 0, 0,0 e -0,0 são todos zero. O mínimo de um valor armazenado em zero e um valor de entrada zero é sempre o valor armazenado. O mínimo de qualquer valor numérico x e NaN é NaN.

ArrayValue

Anexe os elementos fornecidos na ordem se eles ainda não estiverem presentes no valor do campo atual. Se o campo não for uma matriz ou se ainda não existir, ele será definido primeiro como a matriz vazia.

Números equivalentes de tipos diferentes (por exemplo, 3L e 3,0) são considerados iguais ao verificar se um valor está ausente. NaN é igual a NaN, e Nulo é igual a Nulo. Se a entrada tiver vários valores equivalentes, apenas o primeiro será considerado.

O transform_result correspondente será o valor nulo.

ArrayValue

Remova todos os elementos fornecidos da matriz no campo. Se o campo não for uma matriz ou ainda não existir, ele será definido como a matriz vazia.

Números equivalentes dos diferentes tipos (por exemplo, 3L e 3.0) são considerados iguais ao decidir se um elemento deve ser removido. NaN é igual a NaN, e Nulo é igual a Nulo. Isso removerá todos os valores equivalentes se houver cópias.

O transform_result correspondente será o valor nulo.

int64

Número total de resultados retornados, incluindo documentos, projeções, resultados de agregação e chaves.

Duration

Tempo total para executar a consulta no back-end.

int64

Total de operações de leitura faturáveis.

Struct

Estatísticas de depuração a partir da execução da consulta. Observe que as estatísticas de depuração estão sujeitas a alterações à medida que o Firestore evolui. Isso pode incluir: { "indexes_ Assistentes_entradas": "1000", "documentos_escravos": "20", "detalhes_faturamento" : { "documents_billable": "20", "index_Entries_billable": "1000", "min_query_cost": "0" }

int32

O ID de destino ao qual este filtro se aplica.

int32

A contagem total de documentos que correspondem a target_id.

Se for diferente da contagem de documentos no cliente correspondente, o cliente precisará determinar manualmente quais documentos não correspondem mais ao destino.

O cliente pode usar o filtro de flores unchanged_names para ajudar na determinação, testando TODOS os nomes de documentos no filtro. se o nome do documento NÃO estiver no filtro, significa que o documento não corresponde mais ao destino.

BloomFilter

Um filtro Bloom que, apesar do nome, contém as codificações de bytes UTF-8 dos nomes de recursos de TODOS os documentos que correspondem a target_id, no formato projects/{project_id}/databases/{database_id}/documents/{document_path}.

Esse filtro de Bloom pode ser omitido a critério do servidor, como se for considerado que o cliente não vai usá-lo ou se for muito caro em termos computacionais para calcular ou transmitir. Os clientes precisam lidar com esse campo ausente, recorrendo à lógica usada antes da existência desse campo. Ou seja, adicione novamente o destino sem um token de retomada para descobrir quais documentos no cache do cliente estão fora de sincronia.

PlanSummary

Informações da fase de planejamento para a consulta.

ExecutionStats

Estatísticas agregadas da execução da consulta. Presente apenas quando ExplainOptions.analyze está definido como verdadeiro.

bool

Opcional. Define se a consulta será executada.

Se for falso (o padrão), a consulta será planejada, retornando apenas as métricas das etapas de planejamento.

Quando verdadeiro, a consulta é planejada e executada, retornando os resultados completos da consulta com as métricas do estágio de planejamento e execução.

string

Obrigatório. O nome do recurso do documento a ser recebido. Use o formato: projects/{project_id}/databases/{database_id}/documents/{document_path}.

DocumentMask

Os campos a serem retornados. Se não for definido, todos os campos serão retornados.

Se o documento tiver um campo que não esteja presente na máscara, esse campo não será retornado na resposta.

bytes

Lê o documento em uma transação.

Timestamp

Lê a versão do documento no momento especificado.

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 poderá ser um carimbo de data/hora de um minuto inteiro nos últimos sete dias.

string

Obrigatório. O documento pai. Use o formato: projects/{project_id}/databases/{database_id}/documents/{document_path}. Por exemplo: projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

int32

O número máximo de resultados a serem retornados.

string

Um token de página. Precisa ser um valor de ListCollectionIdsResponse.

Timestamp

Lê os documentos como estavam no momento especificado.

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 poderá ser um carimbo de data/hora de um minuto inteiro nos últimos sete dias.

string

Os IDs das coleções.

string

Um token de página que pode ser usado para continuar a lista.

string

Obrigatório. O nome do recurso pai. Use o formato projects/{project_id}/databases/{database_id}/documents ou projects/{project_id}/databases/{database_id}/documents/{document_path}.

Por exemplo: projects/my-project/databases/my-database/documents ou projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

string

Opcional. O ID da coleção, relativo a parent, para a lista.

Por exemplo: chatrooms ou messages.

Ele é opcional e, quando não informado, o Firestore lista documentos de todas as coleções no parent fornecido.

int32

Opcional. O número máximo de documentos a serem retornados em uma única resposta.

O Firestore pode retornar menos do que esse valor.

string

Opcional. Um token de página, recebido de uma resposta ListDocuments anterior.

Forneça isso para recuperar a página subsequente. Ao paginar, todos os outros parâmetros (com exceção de page_size) precisam corresponder aos valores definidos na solicitação que gerou o token da página.

string

Opcional. A ordem opcional dos documentos a serem retornados.

Por exemplo, priority desc, __name__ desc.

Isso espelha o ORDER BY usado nas consultas do Firestore, mas em uma representação de string. Quando ausente, os documentos são ordenados com base em __name__ ASC.

DocumentMask

Opcional. Os campos a serem retornados. Se não for definido, todos os campos serão retornados.

Se um documento tiver um campo que não esteja presente nessa máscara, esse campo não será retornado na resposta.

bool

Se a lista deve mostrar documentos ausentes.

Um documento está ausente se não existe, mas há subdocumentos aninhados abaixo dele. Quando verdadeiro, esses documentos ausentes serão retornados com uma chave, mas não terão os campos, create_time ou update_time definidos.

Solicitações com show_missing não podem especificar where ou order_by.

bytes

Executar a leitura como parte de uma transação já ativa.

Timestamp

Executar a leitura no momento fornecido.

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 poderá ser um carimbo de data/hora de um minuto inteiro nos últimos sete dias.

Document

Os documentos encontrados.

string

Um token para recuperar a próxima página de documentos.

Se esse campo for omitido, não haverá páginas subsequentes.

string

Obrigatório. O nome do banco de dados. Use o formato: projects/{project_id}/databases/{database_id}.

map<string, string>

Rótulos associados a essa alteração de destino.

Target

Um destino para adicionar a este stream.

int32

O ID de um destino a ser removido do stream.

TargetChange

Os destinos foram alterados.

DocumentChange

Um Document foi alterado.

DocumentDelete

Um Document foi excluído.

DocumentRemove

Um Document foi removido de um destino porque não é mais relevante para ele.

ExistenceFilter

Um filtro para aplicar ao conjunto de documentos retornados anteriormente para um determinado destino.

Retornado quando os documentos podem ter sido removidos do destino especificado, mas os documentos exatos são desconhecidos.

map<string, Value>

Campos do mapa.

As chaves do mapa representam os nomes dos campos. Os nomes de campo que correspondem à expressão regular __.*__ são reservados. Nomes de campo reservados são proibidos, exceto em determinados contextos documentados. As chaves do mapa, representadas como UTF-8, não podem exceder 1.500 bytes nem ficar vazias.

string

Obrigatório. O nome do recurso pai. Use o formato: projects/{project_id}/databases/{database_id}/documents. Os nomes de recursos dos documentos não são aceitos. somente nomes de recursos de banco de dados podem ser especificados.

int64

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 um a menos do que o número de consultas paralelas a serem executadas ou, na execução de um job de pipeline de dados, um a menos do que o número de workers ou instâncias de computação disponíveis.

string

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

Por exemplo, duas chamadas subsequentes que usam um page_token podem retornar:

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

Para obter um conjunto de resultados completo ordenado em relação aos resultados da consulta fornecida a PartitionQuery, os conjuntos de resultados devem ser mesclados: cursor A, cursor B, cursor M, cursor Q, cursor U, cursor W

int32

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

Por exemplo, se partition_count = 10 e page_size = 8, a primeira chamada para PartitionQuery retornará até 8 partições e uma next_page_token se houver mais resultados. Uma segunda chamada para PartitionQuery retornará até duas partições para concluir o total de 10 especificadas em partition_count.

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, ordenação, limites, deslocamentos e cursores de início/fim não são compatíveis.

Timestamp

Lê os documentos como estavam no momento especificado.

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 poderá ser um carimbo de data/hora de um minuto inteiro nos últimos sete dias.

Cursor

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

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

• consulta, end_at A
• consulta, início_em A, fim_em B
• consulta, início_em B

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

string

Um token de página que pode ser usado para solicitar um conjunto extra de resultados, até o número especificado por partition_count na solicitação PartitionQuery. Se o campo estiver em branco, não haverá mais resultados.

Struct

Os índices selecionados para a consulta. Por exemplo: [ {"query_scope": "Collection", "properties": "(foo ASC, name ASC)"}, {"query_scope": "Collection", "properties": "(bar ASC, name ASC)"} ]

bool

Quando definido como true, o documento de destino precisa existir. Quando definido como false, o documento de destino não pode existir.

Timestamp

Quando definido, o documento de destino precisa existir e ter sido atualizado pela última vez naquele momento. O carimbo de data/hora precisa estar alinhado em microssegundos.

string

Obrigatório. O nome do banco de dados. Use o formato: projects/{project_id}/databases/{database_id}.

bytes

Obrigatório. A transação a ser revertida.

string

Obrigatório. O nome do recurso pai. Use o formato projects/{project_id}/databases/{database_id}/documents ou projects/{project_id}/databases/{database_id}/documents/{document_path}. Por exemplo: projects/my-project/databases/my-database/documents ou projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

ExplainOptions

Opcional. Explique as opções da consulta. Se definido, serão retornadas estatísticas de consulta adicionais. Caso contrário, apenas os resultados da consulta serão retornados.

StructuredAggregationQuery

Uma consulta de agregação.

bytes

Execute a agregação em uma transação já ativa.

O valor aqui é o ID da transação opaco para executar a consulta.

TransactionOptions

Inicia uma nova transação como parte da consulta, com o padrão somente para leitura.

O novo ID da transação será retornado como a primeira resposta no fluxo.

Timestamp

Executa a consulta no carimbo de data/hora fornecido.

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 poderá ser um carimbo de data/hora de um minuto inteiro nos últimos sete dias.

AggregationResult

Um único resultado de agregação.

Não está presente ao relatar progresso parcial.

bytes

A transação que foi iniciada como parte da solicitação.

Presente apenas na primeira resposta quando a solicitação pede para iniciar uma nova transação.

Timestamp

A hora em que o resultado agregado foi calculado. Ela está sempre aumentando monotonicamente. nesse caso, o AggregateResult anterior no stream de resultados não vai ter sido alterado entre o read_time e este.

Se a consulta não retornar resultados, uma resposta com read_time e nenhum result será enviada, o que representa o horário em que a consulta foi executada.

ExplainMetrics

Explicar as métricas da consulta. Ele só está presente quando o RunAggregationQueryRequest.explain_options é fornecido e é enviado apenas uma vez com a última resposta no stream.

string

Obrigatório. O nome do recurso pai. Use o formato projects/{project_id}/databases/{database_id}/documents ou projects/{project_id}/databases/{database_id}/documents/{document_path}. Por exemplo: projects/my-project/databases/my-database/documents ou projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

ExplainOptions

Opcional. Explique as opções da consulta. Se definido, serão retornadas estatísticas de consulta adicionais. Caso contrário, apenas os resultados da consulta serão retornados.

StructuredQuery

Uma consulta estruturada.

bytes

Execute a consulta em uma transação já ativa.

O valor aqui é o ID da transação opaco para executar a consulta.

TransactionOptions

Inicia uma nova transação e lê os documentos. O padrão é uma transação somente leitura. O novo ID da transação será retornado como a primeira resposta no fluxo.

Timestamp

Lê os documentos como estavam no momento especificado.

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 poderá ser um carimbo de data/hora de um minuto inteiro nos últimos sete dias.

bytes

A transação que foi iniciada como parte da solicitação. Só pode ser definido na primeira resposta e somente se RunQueryRequest.new_transaction tiver sido definido na solicitação. Se definido, nenhum outro campo será definido nesta resposta.

Document

Um resultado de consulta, não definido ao relatar progresso parcial.

Timestamp

A hora em que o documento foi lido. Isso pode estar aumentando monotonicamente; Nesse caso, os documentos anteriores no fluxo de resultados têm a garantia de não serem alterados entre o read_time e este.

Se a consulta não retornar resultados, uma resposta com read_time e nenhum document será enviada, o que representa o horário em que a consulta foi executada.

int32

O número de resultados que foram ignorados devido a um deslocamento entre a última resposta e a atual.

ExplainMetrics

Explicar as métricas da consulta. Ele só está presente quando o RunQueryRequest.explain_options é fornecido e é enviado apenas uma vez com a última resposta no stream.

bool

Se presente, o Firestore concluiu completamente a solicitação e nenhum outro documento será retornado.

Aggregation

Opcional. Série de agregações a serem aplicadas aos resultados do structured_query.

Requer:

• Mínimo de uma e máximo de cinco agregações por consulta.

StructuredQuery

Consulta estruturada aninhada.

string

Opcional. Nome opcional do campo em que o resultado da agregação será armazenado.

Se não for fornecido, o Firestore escolherá um nome padrão seguindo o formato field_<incremental_id++>. Exemplo:

AGGREGATE
  COUNT_UP_TO(1) AS count_up_to_1,
  COUNT_UP_TO(2),
  COUNT_UP_TO(3) AS count_up_to_3,
  COUNT(*)
OVER (
  ...
);

passa a ser:

AGGREGATE
  COUNT_UP_TO(1) AS count_up_to_1,
  COUNT_UP_TO(2) AS field_1,
  COUNT_UP_TO(3) AS count_up_to_3,
  COUNT(*) AS field_2
OVER (
  ...
);

Requer:

• Precisa ser exclusivo em todos os aliases de agregação.
• Seguir as limitações de document field name.

Count

Agregador de contagem.

Sum

Agregador de soma.

Avg

Agregador médio.

FieldReference

O campo de agregação.

Int64Value

Opcional. Restrição opcional sobre o número máximo de documentos a serem contados.

Isso oferece uma maneira de definir um limite superior para o número de documentos a serem verificados, limitando a latência e o custo.

"Não especificado" é interpretado como sem limite.

Exemplo de alto nível:

AGGREGATE COUNT_UP_TO(1000) OVER ( SELECT * FROM k );

Requer:

• Precisa ser maior que zero quando presente.

FieldReference

O campo de agregação.

Projection

Subconjunto opcional dos campos a serem retornados.

Isso funciona como um DocumentMask nos documentos retornados de uma consulta. Quando não definido, presume que o autor da chamada quer que todos os campos sejam retornados.

CollectionSelector

As coleções a serem consultadas.

Filter

O filtro que será aplicado.

Order

A ordem a ser aplicada aos resultados da consulta.

O Firestore permite que os autores de chamadas forneçam uma ordem completa, uma ordem parcial ou nenhuma ordem. Em todos os casos, o Firestore garante uma ordem estável por meio das seguintes regras:

• O order_by é obrigatório para referenciar todos os campos usados com um filtro de desigualdade.
• Todos os campos que precisam estar no order_by, mas que ainda não estão presentes, são anexados na ordem lexicográfica do nome do campo.
• Se um pedido em __name__ não for especificado, ele será anexado por padrão.

Campos são anexados com a mesma direção de classificação que a última ordem especificada, ou 'ASCENDING' caso nenhum pedido tenha sido especificado. Exemplo:

• ORDER BY a se torna ORDER BY a ASC, __name__ ASC
• ORDER BY a DESC se torna ORDER BY a DESC, __name__ DESC
• WHERE a > 1 se torna WHERE a > 1 ORDER BY a ASC, __name__ ASC
• WHERE __name__ > ... AND a > 1 se torna WHERE __name__ > ... AND a > 1 ORDER BY a ASC, __name__ ASC

Cursor

Um possível prefixo de uma posição no conjunto de resultados para iniciar a consulta.

A ordem do conjunto de resultados é baseada na cláusula ORDER BY da consulta original.

SELECT * FROM k WHERE a = 1 AND b > 2 ORDER BY b ASC, __name__ ASC;

Os resultados desta consulta são ordenados por (b ASC, __name__ ASC).

Os cursores podem fazer referência à ordem completa ou a um prefixo do local, mas não podem fazer referência a mais campos do que o ORDER BY fornecido.

Continuando com o exemplo acima, anexar os seguintes cursores de início terá um impacto variável:

• START BEFORE (2, /k/123): inicia a consulta logo antes de a = 1 AND b > 2 AND __name__ > /k/123.
• START AFTER (10): inicia a consulta logo após a = 1 AND b > 10.

Ao contrário de OFFSET, que exige a verificação dos primeiros N resultados para pular, um cursor de início permite que a consulta comece em uma posição lógica. Essa posição não precisa corresponder a um resultado real, ela vai avançar dessa posição para encontrar o próximo documento.

Requer:

• O número de valores não pode ser maior que o número de campos especificado na cláusula ORDER BY.

Cursor

Um possível prefixo de uma posição no conjunto de resultados em que a consulta será encerrada.

Isso é semelhante à START_AT, mas controla a posição final, e não a inicial.

Requer:

• O número de valores não pode ser maior que o número de campos especificado na cláusula ORDER BY.

int32

O número de documentos a serem ignorados antes de retornar o primeiro resultado.

Isso se aplica depois das restrições especificadas por WHERE, START AT e END AT, mas antes da cláusula LIMIT.

Requer:

• Se especificado, o valor precisa ser maior ou igual a zero.

Int32Value

O número máximo de resultados a serem retornados.

Aplica-se após todas as outras restrições.

Requer:

• Se especificado, o valor precisa ser maior ou igual a zero.

FindNearest

Opcional. Uma pesquisa sobre vizinhos mais próximos em potencial.

Aplica-se depois de todos os outros filtros e ordenação.

Encontra os embeddings de vetor mais próximos do vetor de consulta especificado.

string

O ID da coleção. Quando definido, seleciona apenas coleções com esse ID.

bool

Quando falso, seleciona apenas os conjuntos que são filhos imediatos do parent especificado no RunQueryRequest. Quando verdadeiro, seleciona todas as coleções descendentes.

Operator

O operador para combinar vários filtros.

Filter

A lista de filtros a serem combinados.

Requer:

• Pelo menos um filtro está presente.

FieldReference

O campo a ser filtrado.

Operator

O operador a ser filtrado.

Value

O valor a ser comparado.

string

Uma referência a um campo em um documento.

Requer:

• PRECISA ser uma string de segmentos delimitada por ponto (.), em que cada segmento está em conformidade com as limitações de document field name.

CompositeFilter

Um filtro composto.

FieldFilter

Um filtro em um campo do documento.

UnaryFilter

Um filtro que usa exatamente um argumento.

FieldReference

Obrigatório. Um campo de vetor indexado para pesquisar. Somente os documentos que contêm vetores com dimensionalidade correspondente a query_vector podem ser retornados.

Value

Obrigatório. O vetor de consulta que estamos pesquisando. Precisa ser um vetor com no máximo 2.048 dimensões.

DistanceMeasure

Obrigatório. A medida de distância a ser usada, obrigatória.

Int32Value

Obrigatório. O número de vizinhos mais próximos a serem retornados. Precisa ser um número inteiro positivo de até 1.000.

FieldReference

O campo pelo qual ordenar.

Direction

A direção pela qual ordenar. O valor padrão é ASCENDING.

FieldReference

Os campos a serem retornados.

Se estiver vazio, todos os campos serão retornados. Para retornar apenas o nome do documento, use ['__name__'].

Operator

O operador unário a ser aplicado.

FieldReference

O campo ao qual aplicar o operador.

int32

O ID que identifica o destino no stream. Precisa ser um número positivo e diferente de zero.

Se target_id for 0 (ou não especificado), o servidor atribuirá um ID a esse destino e o retornará em um evento TargetChange::ADD. Depois que um destino com target_id=0 é adicionado, todos os destinos subsequentes também precisam ter target_id=0. Se uma solicitação AddTarget com target_id != 0 for enviada ao servidor depois que um destino com target_id=0 for adicionado, o servidor enviará imediatamente uma resposta com um evento TargetChange::Remove.

Se o cliente enviar várias solicitações AddTarget sem um ID, a ordem dos IDs retornados em TargetChage.target_ids vai ser indefinida. Portanto, os clientes devem fornecer um ID de destino em vez de depender do servidor para atribuir um.

Se target_id for diferente de zero, não poderá haver um destino ativo nesse stream com o mesmo ID.

bool

Se o destino precisar ser removido depois de estar atual e consistente.

Int32Value

O número de documentos que corresponderam pela última vez à consulta no token de retomada ou no horário de leitura.

Esse valor só é relevante quando um resume_type é fornecido. A presença de valor maior que zero indica que o cliente quer que ExistenceFilter.unchanged_names seja incluído na resposta.

QueryTarget

Um destino especificado por uma consulta.

DocumentsTarget

Um destino especificado por um conjunto de nomes de documentos.

bytes

Um token de retomada de um TargetChange anterior para um destino idêntico.

O uso de um token de retomada com um destino diferente não é compatível e pode falhar.

Timestamp

Comece a ouvir depois de um read_time específico.

O cliente precisa saber o estado dos documentos correspondentes no momento.

string

Os nomes dos documentos a serem recuperados. Use o formato: projects/{project_id}/databases/{database_id}/documents/{document_path}. A solicitação falhará se algum dos documentos não for um recurso filho da database especificada. Nomes duplicados serão ocultados.

string

O nome do recurso pai. Use o formato projects/{project_id}/databases/{database_id}/documents ou projects/{project_id}/databases/{database_id}/documents/{document_path}. Por exemplo: projects/my-project/databases/my-database/documents ou projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

StructuredQuery

Uma consulta estruturada.

TargetChangeType

O tipo de alteração que ocorreu.

int32

Os IDs das segmentações que foram alteradas.

Se estiver vazio, a mudança será aplicada a todos os destinos.

A ordem dos IDs de destino não foi definida.

Status

O erro que resultou nessa alteração, se aplicável.

bytes

Um token que pode ser usado para retomar o stream para o target_ids especificado ou para todos os destinos se target_ids estiver vazio.

Não é definido em todas as alterações desejadas.

Timestamp

O read_time consistente para o target_ids especificado (omitido quando os target_ids não estão em um snapshot consistente).

O stream vai enviar um read_time com target_ids vazio sempre que todo o stream chegar a um novo snapshot consistente. As mensagens ADD, CURRENT e RESET certamente resultarão em um novo snapshot consistente (ao contrário das mensagens NO_CHANGE e REMOVE).

Para um determinado stream, o aumento de read_time é garantido monotonicamente.

ReadOnly

A transação só pode ser usada para operações de leitura.

ReadWrite

A transação pode ser usada para operações de leitura e gravação.

Timestamp

Lê os documentos em um horário determinado.

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 poderá ser um carimbo de data/hora de um minuto inteiro nos últimos sete dias.

bytes

Uma transação opcional para tentar novamente.

Document

Obrigatório. O documento atualizado. Cria o documento, se ele ainda não existir.

DocumentMask

Os campos a serem atualizados. Nenhum dos caminhos de campo da máscara pode conter um nome reservado.

Se o documento existir no servidor e tiver campos não referenciados na máscara, eles não serão alterados. Os campos referenciados na máscara, mas não presentes no documento de entrada, são excluídos do documento no servidor.

DocumentMask

Os campos a serem retornados. Se não for definido, todos os campos serão retornados.

Se o documento tiver um campo que não esteja presente na máscara, esse campo não será retornado na resposta.

Precondition

Uma pré-condição opcional no documento. A solicitação falhará se esse valor for definido e não for atendido pelo documento de destino.

NullValue

Um valor nulo.

bool

Um valor booleano.

int64

Um valor inteiro.

double

Um valor duplo.

Timestamp

Um valor de carimbo de data/hora.

Precisa apenas até microssegundos. Quando armazenada, qualquer precisão adicional é arredondada para baixo.

string

Um valor de string.

A string, representada como UTF-8, não pode exceder 1 MiB a 89 bytes. Somente os primeiros 1.500 bytes da representação UTF-8 são considerados nas consultas.

bytes

Um valor de bytes.

Não pode exceder 1 MiB a 89 bytes. Somente os primeiros 1.500 bytes são considerados nas consultas.

string

Uma referência a um documento. Por exemplo, projects/{project_id}/databases/{database_id}/documents/{document_path}.

LatLng

Um valor de ponto geográfico que representa um ponto na superfície da Terra.

ArrayValue

Um valor de matriz.

Não pode conter diretamente outro valor de matriz, embora possa conter um mapa com outra matriz.

MapValue

Um valor de mapa.

DocumentMask

Os campos a serem atualizados nesta gravação.

Esse campo só pode ser definido quando a operação é update. Se a máscara não estiver definida para um update e o documento existir, todos os dados existentes serão substituídos. Se a máscara estiver definida e o documento no servidor tiver campos não cobertos pela máscara, eles não serão alterados. Os campos referenciados na máscara, mas não presentes no documento de entrada, são excluídos do documento no servidor. Os caminhos de campo dessa máscara não podem conter um nome de campo reservado.

FieldTransform

As transformações a serem executadas após a atualização.

Esse campo só pode ser definido quando a operação é update. Se estiver presente, essa gravação será equivalente a executar update e transform no mesmo documento atomicamente e em ordem.

Precondition

Uma pré-condição opcional no documento.

A gravação falhará se este valor for definido e não for atendido pelo documento de destino.

Document

Um documento a ser gravado.

string

Um nome de documento a ser excluído. Use o formato: projects/{project_id}/databases/{database_id}/documents/{document_path}.

DocumentTransform

Aplica uma transformação a um documento.

string

Obrigatório. O nome do banco de dados. Use o formato: projects/{project_id}/databases/{database_id}. Isso só é necessário na primeira mensagem.

string

O ID do stream de gravação a ser retomado. Isso só pode ser definido na primeira mensagem. Quando esse campo ficar vazio, um novo stream de gravação será criado.

Write

As gravações a serem aplicadas.

Sempre executado atomicamente e em ordem. Ele precisa estar vazio na primeira solicitação. Pode estar vazio na última solicitação. Ele não pode ficar vazio em todas as outras solicitações.

bytes

Um token de stream enviado anteriormente pelo servidor.

O cliente precisa definir esse campo como o token do WriteResponse mais recente recebido. Isso confirma que o cliente recebeu respostas até esse token. Depois de enviar esse token, os tokens anteriores não poderão mais ser usados.

O servidor poderá fechar o stream se houver muitas respostas não confirmadas.

Deixe esse campo sem definição ao criar uma nova transmissão. Para retomar um stream em um ponto específico, defina este campo e o campo stream_id.

Deixe esse campo sem definição ao criar uma nova transmissão.

map<string, string>

Rótulos associados a esta solicitação de gravação.

string

O ID do fluxo. É definida apenas na primeira mensagem, quando uma nova transmissão é criada.

bytes

Token que representa a posição dessa resposta no stream. Isso pode ser usado por um cliente para retomar o stream neste momento.

Esse campo está sempre definido.

WriteResult

O resultado da aplicação das gravações.

Esse i-ésimo resultado de gravação corresponde à i-ésima gravação na solicitação.

Timestamp

O horário em que a confirmação ocorreu. Qualquer leitura com um read_time igual ou maior garante a visualização dos efeitos da gravação.

Timestamp

O horário da última atualização do documento depois de aplicar a gravação. Não definido após um delete.

Se a gravação não tiver realmente alterado o documento, este será o update_time anterior.

Value

Os resultados da aplicação de cada DocumentTransform.FieldTransform, na mesma ordem.