Package google.firestore.v1beta1

map<string, Value >

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

A chave é o alias atribuído à função de agregação na entrada e o tamanho deste 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. No formato: projects/{project_id}/databases/{database_id} .

string

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

DocumentMask

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

Caso um documento possua um campo que não esteja presente nesta 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 stream.

Timestamp

Lê documentos como eles estavam no momento determinado.

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

bytes

A transação que foi iniciada como parte desta solicitação. Só será definido 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 aumentar monoticamente, neste caso é garantido que os documentos anteriores no fluxo de resultados não foram alterados entre seu read_time e este.

Document

Um documento que foi solicitado.

string

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

string

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

Write

As escritas para aplicar.

O método não aplica gravações atomicamente e não garante a ordenação. Cada gravação é bem-sucedida ou falha de forma independente. Você não pode gravar no mesmo documento mais de uma vez por solicitação.

map<string, string>

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

WriteResult

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

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

Status

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

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

string

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

TransactionOptions

As opções para a 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 comprimento zero.

int32

O número de bits do último byte no bitmap a serem ignorados como "preenchimento". Se o comprimento do bitmap for zero, esse valor deverá ser 0 . Caso contrário, este valor deverá estar entre 0 e 7, inclusive.

BitSequence

Os dados do filtro Bloom.

int32

O número de hashes usados ​​pelo algoritmo.

string

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

Write

As escritas para aplicar.

Sempre executado atomicamente e em ordem.

bytes

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

WriteResult

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

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

Timestamp

A hora em que o commit ocorreu. Qualquer leitura com read_time igual ou maior verá os efeitos do commit.

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 , a ser listado. Por exemplo: chatrooms .

string

O ID do documento atribuído pelo cliente a ser usado para este 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 deve ser definido.

DocumentMask

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

Caso o documento possua um campo que não esteja presente nesta máscara, esse campo não será retornado na resposta.

Value

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

Pode conter menos valores do que o especificado na cláusula order by.

bool

Se a posição estiver logo antes ou logo 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. No formato: projects/{project_id}/databases/{database_id}/documents/{document_path} .

Precondition

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

string

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

map<string, Value >

Timestamp

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

Este valor aumenta monotonicamente quando um documento é excluído e depois recriado. Também pode ser comparado a valores de outros documentos e ao read_time de uma consulta.

Timestamp

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

Este valor é inicialmente definido como create_time e depois aumenta monotonicamente com cada alteração no documento. Também pode ser comparado a valores de outros documentos e ao read_time de uma consulta.

Document

O novo estado do Document .

Se mask estiver definida, conterá apenas os 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 destinos 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 anteriormente correspondiam a esta entidade.

Timestamp

O 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 obter uma referência de sintaxe do caminho do campo.

string

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

int32

Um conjunto de IDs de alvos que correspondiam anteriormente a este documento.

Timestamp

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

Maior ou igual ao commit_time da 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. Isto não deve estar vazio.

string

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

ServerValue

Define o campo para o valor do servidor fornecido.

Value

Adiciona o valor fornecido ao valor atual do campo.

Deve 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 o valor fornecido ou o valor do campo atual forem duplos, 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úmero inteiro positivo/negativo, o campo será resolvido para o número inteiro positivo/negativo de maior magnitude.

Value

Define o campo para o máximo entre seu valor atual e o valor fornecido.

Deve 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 onde o campo e o valor de entrada são de tipos mistos (isto é - um é um número inteiro e o outro é um duplo), o campo assume o tipo do operando maior. Se os operandos forem equivalentes (ex. 3 e 3.0), o campo não muda. 0, 0,0 e -0,0 são todos zero. O máximo de um valor armazenado 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 entre seu valor atual e o valor fornecido.

Deve 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 de entrada. Se uma operação mínima for aplicada onde o campo e o valor de entrada são de tipos mistos (isto é - um é um número inteiro e o outro é um duplo), o campo assume o tipo do operando menor. Se os operandos forem equivalentes (ex. 3 e 3.0), o campo não muda. 0, 0,0 e -0,0 são todos zero. O mínimo de um valor armazenado 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 em ordem, caso eles ainda não estejam presentes no valor do campo atual. Se o campo não for uma matriz ou se ainda não existir, ele será primeiro definido como uma matriz vazia.

Números equivalentes de tipos diferentes (por exemplo, 3L e 3,0) são considerados iguais ao verificar se um valor está faltando. NaN é igual a NaN e Nulo é igual a Nulo. Se a entrada contiver 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 se o campo ainda não existir, ele será definido como uma 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 duplicatas.

O transform_result correspondente será o valor nulo.

int32

O ID de destino ao qual esse filtro se aplica.

int32

A contagem total de documentos que correspondem target_id .

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

O cliente pode usar o filtro Bloom unchanged_names para auxiliar nessa determinação, testando TODOS os nomes de documentos em relação ao 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 dos recursos de TODOS os documentos que correspondem target_id , no formato projects/{project_id}/databases/{database_id}/documents/{document_path} .

Este filtro bloom pode ser omitido a critério do servidor, como se for considerado que o cliente não fará uso dele ou se for muito caro do ponto de vista computacional para calcular ou transmitir. Os clientes devem lidar normalmente com a ausência desse campo, recorrendo à lógica usada antes da existência desse campo; isto é, adicione novamente o destino sem um token de retomada para descobrir quais documentos no cache do cliente estão fora de sincronia.

string

Obrigatório. O nome do recurso do Documento a ser obtido. No formato: projects/{project_id}/databases/{database_id}/documents/{document_path} .

DocumentMask

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

Caso o documento possua um campo que não esteja presente nesta 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 determinado.

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

string

Obrigatório. O documento pai. No 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. Deve ser um valor de ListCollectionIdsResponse .

Timestamp

Lê documentos como eles estavam no momento determinado.

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

string

Os IDs da coleção.

string

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

string

Obrigatório. O nome do recurso pai. No 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 , a ser listado.

Por exemplo: chatrooms ou messages .

Isso é opcional e, quando não fornecido, o Firestore listará os 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 que esse valor.

string

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

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

string

Opcional. A ordenação facultativa dos documentos a devolver.

Por exemplo: priority desc, __name__ desc .

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

DocumentMask

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

Caso um documento possua um campo que não esteja presente nesta máscara, esse campo não será retornado na resposta.

bool

Se a lista mostrar documentos faltantes.

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

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

bytes

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

Timestamp

Execute a leitura no horário fornecido.

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

Document

Os documentos encontrados.

string

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

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

string

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

map<string, string>

Os rótulos associados a esse destino mudam.

Target

Um alvo para adicionar a este fluxo.

int32

O ID de um destino a ser removido deste fluxo.

TargetChange

Os alvos mudaram.

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 esse destino).

ExistenceFilter

Um filtro a ser aplicado ao conjunto de documentos retornados anteriormente para um determinado destino.

Retornado quando os documentos podem ter sido removidos de um determinado destino, mas os documentos exatos são desconhecidos.

map<string, Value >

Os campos do mapa.

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

string

Obrigatório. O nome do recurso pai. No formato: projects/{project_id}/databases/{database_id}/documents . Nomes de recursos de documentos não são suportados; apenas 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 deve ser positivo. O número real de partições retornadas pode ser menor.

Por exemplo, isso pode ser definido como um a menos que o número de consultas paralelas a serem executadas ou, na execução de um trabalho de pipeline de dados, um a menos que o número de trabalhadores 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 obter um conjunto adicional de resultados. Não há garantias de ordenação entre conjuntos de resultados. Assim, o uso de vários conjuntos de resultados exigirá a fusão dos diferentes conjuntos de resultados.

Por exemplo, duas chamadas subsequentes usando 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 ao 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 nesta 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 um next_page_token se existirem mais resultados. Uma segunda chamada para PartitionQuery retornará até 2 partições, para completar o total de 10 especificadas em partition_count .

StructuredQuery

Uma consulta estruturada. A consulta deve especificar a coleção com todos os descendentes e ser ordenada por nome crescente. Outros filtros, ordenar por, limites, deslocamentos e cursores de início/fim não são suportados.

Timestamp

Lê documentos como eles estavam no momento determinado.

Deve ser um carimbo de data/hora com precisão de microssegundos da última hora ou, se a recuperação pontual estiver ativada, também pode ser um carimbo de hora de um minuto inteiro dos últimos 7 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 devem ser feitas com a mesma consulta fornecida para esta solicitação PartitionQuery. Os cursores de partição serão ordenados de acordo com a mesma ordem dos resultados da consulta fornecida ao 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, start_at A, end_at B
• consulta, start_at B

Um resultado vazio pode indicar que a consulta tem poucos resultados para ser particionada ou que a consulta ainda não tem suporte para particionamento.

string

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

bool

Quando definido como true , o documento de destino deverá existir. Quando definido como false , o documento de destino não deve existir.

Timestamp

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

string

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

bytes

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

string

Obrigatório. O nome do recurso pai. No 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

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 opaca para executar a consulta.

TransactionOptions

Inicia uma nova transação como parte da consulta, padronizando como somente leitura.

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

Timestamp

Executa a consulta no carimbo de data/hora fornecido.

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

AggregationResult

Um único resultado de agregação.

Não presente ao relatar progresso parcial.

bytes

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

Presente apenas na primeira resposta quando a solicitação solicitou o início de uma nova transação.

Timestamp

A hora em que o resultado agregado foi calculado. Isto está sempre aumentando monotonicamente; neste caso, é garantido que o AggregationResult anterior no fluxo de resultados não mudou entre seu read_time e este.

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

string

Obrigatório. O nome do recurso pai. No 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.

bytes

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

O valor aqui é o ID da transação opaca 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 stream.

Timestamp

Lê documentos como eles estavam no momento determinado.

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

bytes

A transação que foi iniciada como parte desta 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. Isto pode estar aumentando monotonicamente; Nesse caso, os documentos anteriores no fluxo de resultados têm certeza de que não foram alterados entre read_time e este.

Se a consulta não retornar resultados, uma resposta com read_time e nenhum document será enviado, e isso 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 resposta atual.

bool

Se presente, o Firestore terminou completamente a solicitação e não serão devolvidos mais documentos.

Aggregation

Opcional. Série de agregações para aplicar sobre os resultados do structured_query .

Requer:

• Um mínimo de um e no máximo de cinco agregações por consulta.

StructuredQuery

Consulta estruturada aninhada.

string

Opcional. Nome opcional do campo para armazenar o resultado da agregação.

Se não for fornecido, o Firestore escolherá um nome padrão seguindo o formato field_<incremental_id++> . Por 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 (
  ...
);

torna-se:

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:

• Deve ser único em todos os aliases de agregação.
• Conforme para document field name .

Count

Agregador de contagem.

Sum

Agregador da soma.

Avg

Agregador médio.

FieldReference

O campo para agregar.

Int64Value

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

Isso fornece uma maneira de definir um limite superior no número de documentos para digitalizar, limitar a latência e o custo.

Não especificado é interpretado como nenhum vinculado.

Exemplo de alto nível:

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

Requer:

• Deve ser maior que zero quando presente.

FieldReference

O campo para agregar.

Projection

Sub-definição opcional dos campos para retornar.

Isso atua como uma DocumentMask sobre os documentos retornados de uma consulta. Quando não está definido, pressupõe que o chamador deseja que todos os campos sejam retornados.

CollectionSelector

As coleções para consultar.

Filter

O filtro a ser aplicado.

Order

O pedido para se aplicar aos resultados da consulta.

A Firestore permite que os chamadores forneçam uma ordem completa, uma ordem parcial ou nenhum pedido. Em todos os casos, a Firestore garante uma ordem estável através das seguintes regras:

• O order_by é obrigado a referenciar todos os campos usados ​​com um filtro de desigualdade.
• Todos os campos que devem estar no order_by , mas 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.

Os campos são anexados com a mesma direção de classificação que a última ordem especificada ou 'ascendente' se nenhum pedido foi especificado. Por exemplo:

• ORDER BY a torna -se 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 torna -se WHERE __name__ > ... AND a > 1 ORDER BY a ASC, __name__ ASC

Cursor

Um prefixo potencial de uma posição no conjunto de resultados para iniciar a consulta em.

A ordem do conjunto de resultados é baseada na cláusula ORDER BY 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, embora não possa referenciar mais campos do que o que está na ORDER BY .

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

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

Ao contrário OFFSET , o que requer a digitalização nos primeiros n resultados a pular, um cursor de partida permite que a consulta comece em uma posição lógica. Esta posição não é necessária para corresponder a um resultado real, ela será digitalizada a partir desta 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 especificados na cláusula ORDER BY .

Cursor

Um prefixo potencial de uma posição no resultado definido para encerrar a consulta em.

Isso é semelhante ao START_AT , mas com ele controlando a posição final e não a posição inicial.

Requer:

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

int32

O número de documentos para pular antes de retornar o primeiro resultado.

Isso se aplica após as restrições especificadas pelo WHERE , START AT e END AT mas antes da cláusula LIMIT .

Requer:

• O valor deve ser maior ou igual a zero, se especificado.

Int32Value

O número máximo de resultados para retornar.

Aplica -se depois de todas as outras restrições.

Requer:

• O valor deve ser maior ou igual a zero, se especificado.

string

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

bool

Quando falsa, seleciona apenas coleções que são filhos imediatos dos parent especificados no RunQueryRequest contendo. Quando é verdade, seleciona todas as coleções descendentes.

Operator

O operador para combinar vários filtros.

Filter

A lista de filtros para combinar.

Requer:

• Pelo menos um filtro está presente.

FieldReference

O campo para filtrar.

Operator

O operador para filtrar.

Value

O valor para comparar.

string

Uma referência a um campo em um documento.

Requer:

• Deve ser uma string de segmentos delimitados ( . ) document field name (.

CompositeFilter

Um filtro composto.

FieldFilter

Um filtro em um campo de documento.

UnaryFilter

Um filtro que leva exatamente um argumento.

FieldReference

O campo para encomendar.

Direction

A direção para encomendar por. Padrões para ASCENDING .

FieldReference

Os campos para retornar.

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

Operator

O operador unário para aplicar.

FieldReference

O campo ao qual aplicar o operador.

int32

O ID de destino que identifica o alvo no fluxo. Deve ser um número positivo e diferente de zero.

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

Observe que, se o cliente enviar várias solicitações AddTarget sem um ID, a ordem dos IDs retornou no TargetChage.target_ids será indefinida. Portanto, os clientes devem fornecer um ID de destino em vez de confiar no servidor para atribuir um.

Se target_id não for diferente de zero, não deve haver um alvo ativo existente nesse fluxo com o mesmo ID.

bool

Se o alvo for removido quando estiver atual e consistente.

Int32Value

O número de documentos que corresponderam pela última vez à consulta no token de currículo ou no tempo de leitura.

Este valor é relevante apenas quando um resume_type é fornecido. Este valor está presente e maior que zero sinais de que o cliente deseja que ExistenceFilter.unchanged_names seja incluído na resposta.

QueryTarget

Um alvo especificado por uma consulta.

DocumentsTarget

Um alvo especificado por um conjunto de nomes de documentos.

bytes

Um token de currículo de uma TargetChange anterior para um alvo idêntico.

O uso de um token de currículo com um alvo diferente não é suportado e pode falhar.

Timestamp

Comece a ouvir após um read_time específico.

O cliente deve conhecer o estado dos documentos correspondentes neste momento.

string

Os nomes dos documentos para recuperar. No formato: projects/{project_id}/databases/{database_id}/documents/{document_path} . A solicitação falhará se algum documento não for um recurso filho do database especificado. Os nomes duplicados serão eliminados.

string

O nome do recurso pai. No 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 mudança que ocorreu.

int32

Os IDs de destino dos alvos que mudaram.

Se vazio, a alteração se aplica a todos os objetivos.

A ordem dos IDs de destino não está definida.

Status

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

bytes

Um token que pode ser usado para retomar o fluxo para os especificados target_ids ou todos os alvos se target_ids estiver vazio.

Não definido em todas as mudanças de destino.

Timestamp

O consistente read_time para o target_ids fornecido (omitido quando os Target_ids não estão em um instantâneo consistente).

É garantido que o fluxo envie um read_time com target_ids vazio sempre que todo o fluxo atingir um novo instantâneo consistente. Adicionar, as mensagens atuais e de redefinição são garantidas (eventualmente) resultam em um novo instantâneo consistente (enquanto o NO_CHANGE e REMOVEM as mensagens não são).

Para um determinado fluxo, read_time é garantido para aumentar 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ê documentos no horário determinado.

Este deve ser um registro de data e hora de precisão de microssegundos na última hora, ou se a recuperação do ponto de vista estiver ativada, também poderá ser um timestamp de minuto inteiro nos últimos 7 dias.

bytes

Uma transação opcional para tentar novamente.

Document

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

DocumentMask

Os campos para atualizar. Nenhum dos caminhos de campo na máscara pode conter um nome reservado.

Se o documento existir no servidor e tiver campos não referenciados na máscara, eles permanecerão inalterados. 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 para retornar. Se não estiver definido, retorna todos os campos.

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

Precondition

Uma pré -condição opcional no documento. A solicitação falhará se isso 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.

Preciso apenas para microssegundos. Quando armazenado, qualquer precisão adicional é arredondada.

string

Um valor de string.

A string, representada como UTF -8, não deve exceder 1 MIB - 89 bytes. Somente os primeiros 1.500 bytes da representação UTF-8 são considerados por consultas.

bytes

Um valor de bytes.

Não deve exceder 1 MIB - 89 bytes. Apenas os primeiros 1.500 bytes são considerados por 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 representando 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 que contenha outra matriz.

MapValue

Um valor de mapa.

DocumentMask

Os campos a serem atualizados nesta gravação.

Este campo pode ser definido apenas quando a operação é update . Se a máscara não estiver definida para uma update e o documento existir, quaisquer dados existentes serão substituídos. Se a máscara estiver definida e o documento no servidor possui campos não cobertos pela máscara, eles permanecerão inalterados. 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 nesta máscara não devem conter um nome de campo reservado.

FieldTransform

As transformações para se apresentar após a atualização.

Este campo pode ser definido apenas quando a operação é update . Se presente, esta gravação é 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 isso for definido e não for atendido pelo documento de destino.

Document

Um documento para escrever.

string

Um nome de documento para excluir. No formato: projects/{project_id}/databases/{database_id}/documents/{document_path} .

DocumentTransform

Aplica uma transformação em um documento.

string

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

string

O ID do fluxo de gravação para retomar. Isso só pode ser definido na primeira mensagem. Quando deixado vazio, um novo fluxo de gravação será criado.

Write

As gravações para aplicar.

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

bytes

Um token de fluxo que foi enviado anteriormente pelo servidor.

O cliente deve definir esse campo para o token da resposta mais recente do WriteResponse que recebeu. Isso reconhece que o cliente recebeu respostas até esse token. Depois de enviar este token, os tokens anteriores podem não ser mais usados.

O servidor pode fechar o fluxo se houver muitas respostas não reconhecidas.

Deixe este campo sem definir ao criar um novo fluxo. Para retomar um fluxo em um ponto específico, defina este campo e o campo stream_id .

Deixe este campo sem definir ao criar um novo fluxo.

map<string, string>

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

string

O ID do fluxo. Definido apenas na primeira mensagem, quando um novo fluxo foi criado.

bytes

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

Este campo está sempre definido.

WriteResult

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

Este i-és de gravação corresponde à i-ésima gravação na solicitação.

Timestamp

O momento em que o commit ocorreu. Qualquer leitura com um read_time IGAL ou MAIS Garantido para ver os efeitos da gravação.

Timestamp

O último horário de atualização do documento após a aplicação da gravação. Não definido após uma delete .

Se a gravação não alterou o documento, este será o Update_time anterior.

Value

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