Índice
Firestore
(interface)AggregationResult
(mensagem)ArrayValue
(mensagem)BatchGetDocumentsRequest
(mensagem)BatchGetDocumentsResponse
(mensagem)BatchWriteRequest
(mensagem)BatchWriteResponse
(mensagem)BeginTransactionRequest
(mensagem)BeginTransactionResponse
(mensagem)BitSequence
(mensagem)BloomFilter
(mensagem)CommitRequest
(mensagem)CommitResponse
(mensagem)CreateDocumentRequest
(mensagem)Cursor
(mensagem)DeleteDocumentRequest
(mensagem)Document
(mensagem)DocumentChange
(mensagem)DocumentDelete
(mensagem)DocumentMask
(mensagem)DocumentRemove
(mensagem)DocumentTransform
(mensagem)DocumentTransform.FieldTransform
(mensagem)DocumentTransform.FieldTransform.ServerValue
(enum)ExecutionStats
(mensagem)ExistenceFilter
(mensagem)ExplainMetrics
(mensagem)ExplainOptions
(mensagem)GetDocumentRequest
(mensagem)ListCollectionIdsRequest
(mensagem)ListCollectionIdsResponse
(mensagem)ListDocumentsRequest
(mensagem)ListDocumentsResponse
(mensagem)ListenRequest
(mensagem)ListenResponse
(mensagem)MapValue
(mensagem)PartitionQueryRequest
(mensagem)PartitionQueryResponse
(mensagem)PlanSummary
(mensagem)Precondition
(mensagem)RollbackRequest
(mensagem)RunAggregationQueryRequest
(mensagem)RunAggregationQueryResponse
(mensagem)RunQueryRequest
(mensagem)RunQueryResponse
(mensagem)StructuredAggregationQuery
(mensagem)StructuredAggregationQuery.Aggregation
(mensagem)StructuredAggregationQuery.Aggregation.Avg
(mensagem)StructuredAggregationQuery.Aggregation.Count
(mensagem)StructuredAggregationQuery.Aggregation.Sum
(mensagem)StructuredQuery
(mensagem)StructuredQuery.CollectionSelector
(mensagem)StructuredQuery.CompositeFilter
(mensagem)StructuredQuery.CompositeFilter.Operator
(enum)StructuredQuery.Direction
(enum)StructuredQuery.FieldFilter
(mensagem)StructuredQuery.FieldFilter.Operator
(enum)StructuredQuery.FieldReference
(mensagem)StructuredQuery.Filter
(mensagem)StructuredQuery.FindNearest
(mensagem)StructuredQuery.FindNearest.DistanceMeasure
(enum)StructuredQuery.Order
(mensagem)StructuredQuery.Projection
(mensagem)StructuredQuery.UnaryFilter
(mensagem)StructuredQuery.UnaryFilter.Operator
(enum)Target
(mensagem)Target.DocumentsTarget
(mensagem)Target.QueryTarget
(mensagem)TargetChange
(mensagem)TargetChange.TargetChangeType
(enum)TransactionOptions
(mensagem)TransactionOptions.ReadOnly
(mensagem)TransactionOptions.ReadWrite
(mensagem)UpdateDocumentRequest
(mensagem)Value
(mensagem)Write
(mensagem)WriteRequest
(mensagem)WriteResponse
(mensagem)WriteResult
(mensagem)
Firestore
O serviço do Cloud Firestore.
O Cloud Firestore é um banco de dados de documentos NoSQL rápido, totalmente gerenciado, sem servidor e nativo da nuvem que simplifica o armazenamento, a sincronização e a consulta de dados para seus aplicativos em dispositivos móveis, na Web e de IoT em escala global. As bibliotecas de cliente dele oferecem sincronização em tempo real e suporte off-line. Além disso, os recursos de segurança e de integração com o Firebase e o Google Cloud Platform aceleram a criação de aplicativos verdadeiramente sem servidor.
BatchGetDocuments |
---|
Recebe vários documentos. Não há garantia de que os documentos retornados por esse método sejam retornados na mesma ordem em que foram solicitados.
|
BatchWrite |
---|
Aplica um lote de operações de gravação. O método BatchWrite não aplica as operações de gravação atomicamente e pode aplicá-las fora de ordem. O método não permite mais de uma gravação por documento. Cada gravação é bem-sucedida ou falha de forma independente. Consulte o Se você precisar de um conjunto de gravações aplicado atomicamente, use
|
BeginTransaction |
---|
Inicia uma nova transação.
|
Confirmar |
---|
Confirma uma transação e, opcionalmente, atualiza os documentos.
|
CreateDocument |
---|
Cria um novo documento.
|
DeleteDocument |
---|
Exclui um documento.
|
GetDocument |
---|
Recebe um único documento.
|
ListCollectionIds |
---|
Lista todos os IDs de coleção sob um documento.
|
ListDocuments |
---|
Lista os documentos.
|
Ouvir |
---|
Ouve as mudanças. Este método está disponível apenas via gRPC ou WebChannel (não REST).
|
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 pelo RunQuery como ponto inicial/final para os resultados da consulta.
|
Reverter |
---|
Reverte uma transação.
|
RunAggregationQuery |
---|
Executa uma consulta de agregação. Em vez de produzir resultados Exemplo de alto nível:
|
RunQuery |
---|
Executa uma consulta.
|
UpdateDocument |
---|
Atualiza ou insere um documento.
|
Gravar |
---|
Transmite lotes de atualizações e exclusões de documentos em ordem. Este método está disponível apenas via gRPC ou WebChannel (não REST).
|
AggregationResult
O resultado de um único bucket de uma consulta de agregação do Firestore.
As chaves de aggregate_fields
são as mesmas para todos os resultados em uma consulta de agregação, ao contrário das consultas de documentos, que podem ter campos diferentes para cada resultado.
Campos | |
---|---|
aggregate_fields |
O resultado das funções de agregação, por exemplo: A chave é a |
ArrayValue
Um valor de matriz.
Campos | |
---|---|
values[] |
Valores na matriz. |
BatchGetDocumentsRequest
A solicitação para Firestore.BatchGetDocuments
.
Campos | |
---|---|
database |
Obrigatório. O nome do banco de dados. Use o formato: |
documents[] |
Os nomes dos documentos a serem recuperados. Use o formato: |
mask |
Os campos a serem retornados. Se não definido, retorna todos os campos. Se um documento tiver um campo ausente nessa máscara, esse campo não será retornado na resposta. |
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 |
Lê documentos em uma transação. |
new_transaction |
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. |
read_time |
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. |
BatchGetDocumentsResponse
A resposta transmitida para Firestore.BatchGetDocuments
.
Campos | |
---|---|
transaction |
A transação que foi iniciada como parte desta solicitação. Só será definido na primeira resposta, e apenas se |
read_time |
A hora em que o documento foi lido. Isso pode estar aumentando constantemente. Nesse caso, é garantido que os documentos anteriores no fluxo de resultados não serão alterados entre o read_time e o atual. |
Campo de união result . Um único resultado. Pode ficar vazio se o servidor estiver apenas retornando uma transação. result pode ser apenas de um dos tipos a seguir: |
|
found |
Um documento que foi solicitado. |
missing |
Um nome de documento que foi solicitado, mas não existe. Use o formato: |
BatchWriteRequest
A solicitação para Firestore.BatchWrite
.
Campos | |
---|---|
database |
Obrigatório. O nome do banco de dados. Use o formato: |
writes[] |
As gravações a serem aplicadas. O método não aplica as gravações atomicamente e não garante a ordenação. Cada gravação é bem-sucedida ou falha de forma independente. Não é possível gravar no mesmo documento mais de uma vez por solicitação. |
labels |
Rótulos associados a essa gravação em lote. |
BatchWriteResponse
A resposta de Firestore.BatchWrite
.
Campos | |
---|---|
write_results[] |
O resultado da aplicação das gravações. O resultado i-th write corresponde à i-th write na solicitação. |
status[] |
O status de aplicação das gravações. Esse status de gravação i-th corresponde à i-th gravação na solicitação. |
BeginTransactionRequest
A solicitação para Firestore.BeginTransaction
.
Campos | |
---|---|
database |
Obrigatório. O nome do banco de dados. Use o formato: |
options |
Opções da transação. O padrão é uma transação de leitura/gravação. |
BeginTransactionResponse
A resposta para Firestore.BeginTransaction
.
Campos | |
---|---|
transaction |
A transação que foi iniciada. |
BitSequence
Uma sequência de bits, codificada em uma matriz de bytes.
Cada byte na matriz de bytes bitmap
armazena 8 bits da sequência. A única exceção é o último byte, que pode armazenar até 8 bits ou menos. O padding
define o número de bits do último byte a ser ignorado como "padding". Os valores desses bits de "padding" não são especificados e precisam ser ignorados.
Para recuperar o primeiro bit, o bit 0, calcule: (bitmap[0] & 0x01) != 0
. Para recuperar o segundo bit, bit 1, calcule: (bitmap[0] & 0x02) != 0
. Para recuperar o terceiro bit, bit 2, calcule: (bitmap[0] & 0x04) != 0
. Para recuperar o quarto bit, bit 3, calcule: (bitmap[0] & 0x08) != 0
. Para recuperar o bit n, calcule: (bitmap[n / 8] & (0x01 << (n % 8))) != 0
.
O "tamanho" de um BitSequence
(o número de bits que ele contém) é calculado por esta fórmula: (bitmap.length * 8) - padding
.
Campos | |
---|---|
bitmap |
Os bytes que codificam a sequência de bits. O comprimento pode ser igual a zero. |
padding |
O número de bits do último byte em |
BloomFilter
Um filtro de flores (https://en.wikipedia.org/wiki/Bloom_filter).
O filtro Bloom gera hash das entradas com MD5 e trata o hash de 128 bits resultante como dois valores de hash de 64 bits distintos, interpretados como números inteiros não assinados usando a codificação de complemento de 2.
Esses dois valores de hash, chamados h1
e h2
, são usados para calcular os valores de hash hash_count
usando a fórmula, começando em i=0
:
h(i) = h1 + (i * h2)
Esses valores resultantes são então obtidos módulo o número de bits no filtro Bloom para obter os bits do filtro Bloom para testar a entrada determinada.
Campos | |
---|---|
bits |
Os dados do filtro de flor. |
hash_count |
O número de hashes usados pelo algoritmo. |
CommitRequest
A solicitação para Firestore.Commit
.
Campos | |
---|---|
database |
Obrigatório. O nome do banco de dados. Use o formato: |
writes[] |
As gravações a serem aplicadas. Sempre executado atomicamente e em ordem. |
transaction |
Se definido, aplica todas as gravações nessa transação e as confirma. |
CommitResponse
A resposta para Firestore.Commit
.
Campos | |
---|---|
write_results[] |
O resultado da aplicação das gravações. O resultado i-th write corresponde à i-th write na solicitação. |
commit_time |
A hora em que a confirmação ocorreu. Qualquer leitura com um |
CreateDocumentRequest
A solicitação para Firestore.CreateDocument
.
Campos | |
---|---|
parent |
Obrigatório. O recurso pai. Por exemplo, |
collection_id |
Obrigatório. O ID da coleção, relativo a |
document_id |
O ID do documento atribuído pelo cliente a ser usado neste documento. Opcional. Se não for especificado, um ID será atribuído pelo serviço. |
document |
Obrigatório. O documento que será criado. |
mask |
Os campos a serem retornados. Se não definido, retorna todos os campos. Se o documento tiver um campo ausente nessa máscara, esse campo não será retornado na resposta. |
Cursor
Uma posição em um conjunto de resultados de consulta.
Campos | |
---|---|
values[] |
Os valores que representam uma posição, na ordem em que aparecem e na ordem por cláusula de uma consulta. Pode conter menos valores do que o especificado na ordem por cláusula. |
before |
Se a posição é logo antes ou logo depois dos valores fornecidos, relativa à ordem de classificação definida pela consulta. |
DeleteDocumentRequest
A solicitação para Firestore.DeleteDocument
.
Campos | |
---|---|
name |
Obrigatório. O nome do recurso do documento a ser excluído. Use o formato: |
current_document |
Uma condição prévia opcional no documento. A solicitação falhará se isso for definido e não for atendido pelo documento de destino. |
Documento
Um documento do Firestore.
Não pode exceder 1 MiB a 4 bytes.
Campos | |
---|---|
name |
O nome do recurso do documento, por exemplo, |
fields |
|
create_time |
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 |
update_time |
Apenas saída. A hora em que o documento foi alterado pela última vez. Inicialmente, esse valor é definido como |
DocumentChange
Um Document
mudou.
Pode ser o resultado de várias writes
, incluindo exclusões, que resultaram em um novo valor para a Document
.
Várias mensagens DocumentChange
poderão ser retornadas para a mesma alteração lógica, se vários destinos forem afetados.
Campos | |
---|---|
document |
O novo estado da Se |
target_ids[] |
Um conjunto de IDs de destinos que correspondem a este documento. |
removed_target_ids[] |
Um conjunto de IDs para destinos que não correspondem mais a esse documento. |
DocumentDelete
Um Document
foi excluído.
Pode ser resultado de várias writes
, incluindo atualizações, em que a última excluiu a Document
.
Várias mensagens DocumentDelete
poderão ser retornadas para a mesma exclusão lógica, se vários destinos forem afetados.
Campos | |
---|---|
document |
O nome do recurso do |
removed_target_ids[] |
Um conjunto de IDs de destinos que corresponderam anteriormente a essa entidade. |
read_time |
O carimbo de data/hora de leitura em que a exclusão foi observada. Maior ou igual ao |
DocumentMask
Um conjunto de caminhos de campo em um documento. Usado para restringir uma operação de recebimento ou atualização em um documento a um subconjunto dos campos. Isso é diferente das máscaras de campo padrão, já que o escopo é sempre um Document
e considera a natureza dinâmica de Value
.
Campos | |
---|---|
field_paths[] |
Lista de caminhos de campo na máscara. Consulte |
DocumentRemove
Um Document
foi removido da visualização dos destinos.
Enviado se o documento não for mais relevante para um destino e estiver fora da visualização. Pode ser enviado no lugar de um DocumentDelete ou DocumentChange se o servidor não puder enviar o novo valor do documento.
Várias mensagens DocumentRemove
poderão ser retornadas para a mesma gravação ou exclusão lógica, se vários destinos forem afetados.
Campos | |
---|---|
document |
O nome do recurso |
removed_target_ids[] |
Um conjunto de IDs para destinos que corresponderam anteriormente a este documento. |
read_time |
O carimbo de data/hora de leitura em que a remoção foi observada. Maior ou igual ao |
DocumentTransform
A transformação de um documento.
Campos | |
---|---|
document |
O nome do documento a ser transformado. |
field_transforms[] |
A lista de transformações a serem aplicadas aos campos do documento, em ordem. Este campo não pode ficar vazio. |
FieldTransform
Uma transformação de um campo do documento.
Campos | |
---|---|
field_path |
Caminho do campo. Consulte |
Campo de união transform_type . A transformação a ser aplicada no campo. transform_type pode ser apenas de um dos tipos a seguir: |
|
set_to_server_value |
Define o campo como o valor do servidor fornecido. |
increment |
Adiciona o valor fornecido 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 for duplo, 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 positivo/negativo, o campo será resolvido para o maior número inteiro positivo/negativo de magnitude. |
maximum |
Define o campo como o máximo de seu valor atual e o valor fornecido. 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 quando o campo e o valor de entrada forem de tipos mistos (ou seja, um é um número inteiro e o 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 zero armazenado e um valor de entrada zero é sempre o valor armazenado. O máximo de qualquer valor numérico x e NaN é NaN. |
minimum |
Define o campo para o mínimo entre seu valor atual e o valor fornecido. 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 quando o campo e o valor de entrada forem de tipos mistos (ou seja, um é um número inteiro e o 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 zero armazenado e um valor de entrada zero é sempre o valor armazenado. O mínimo de qualquer valor numérico x e NaN é NaN. |
append_missing_elements |
Anexe os elementos fornecidos em 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 contiver vários valores equivalentes, somente o primeiro será considerado. O transform_result correspondente será o valor nulo. |
remove_all_from_array |
Remova todos os elementos fornecidos da matriz no campo. Se o campo não for uma matriz ou se ainda não existir, ele será definido como a matriz vazia. Os números equivalentes dos diferentes tipos (por exemplo, 3L e 3.0) são considerados iguais ao decidir se um elemento precisa 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. |
ServerValue
Um valor calculado pelo servidor.
Enums | |
---|---|
SERVER_VALUE_UNSPECIFIED |
Não especificado. Esse valor não pode ser usado. |
REQUEST_TIME |
A hora em que o servidor processou a solicitação, com precisão de milissegundos. Se usado em vários campos (documentos iguais ou diferentes) em uma transação, todos os campos terão o mesmo carimbo de data/hora do servidor. |
ExecutionStats
Estatísticas de execução da consulta.
Campos | |
---|---|
results_returned |
Número total de resultados retornados, incluindo documentos, projeções, resultados de agregação e chaves. |
execution_duration |
Tempo total para executar a consulta no back-end. |
read_operations |
Total de operações de leitura faturáveis. |
debug_stats |
Depuração de estatísticas da execução da consulta. As estatísticas de depuração estão sujeitas a alterações à medida que o Firestore evolui. It could include: { "indexes_entries_scanned": "1000", "documents_scanned": "20", "billing_details" : { "documents_billable": "20", "index_entries_billable": "1000", "min_query_cost": "0" } } |
ExistenceFilter
Um resumo de todos os documentos que correspondem a um determinado destino.
Campos | |
---|---|
target_id |
O ID do destino ao qual esse filtro se aplica. |
count |
O total de documentos que correspondem a Se for diferente da contagem de documentos no cliente correspondentes, o cliente precisará determinar manualmente quais documentos não correspondem mais ao destino. O cliente pode usar o filtro Bloom |
unchanged_names |
Um filtro de Bloom que, apesar do nome, contém as codificações de byte UTF-8 dos nomes de recursos de TODOS os documentos que correspondem a Esse filtro de Bloom pode ser omitido a critério do servidor, por exemplo, se for considerado que o cliente não vai usá-lo ou se o cálculo ou transmissão for muito caro. Os clientes devem tratar corretamente a ausência desse campo recorrendo à lógica usada antes da existência do campo, ou seja, adicionar novamente o destino sem um token de retomada para descobrir quais documentos no cache do cliente estão fora de sincronia. |
ExplainMetrics
Explique as métricas da consulta.
Campos | |
---|---|
plan_summary |
Informações da fase de planejamento da consulta. |
execution_stats |
Estatísticas agregadas da execução da consulta. Presente apenas quando |
ExplainOptions
Explique as opções para a consulta.
Campos | |
---|---|
analyze |
Opcional. Define se esta consulta será executada. Quando for definida como falsa (o padrão), a consulta será planejada, retornando apenas métricas dos estágios de planejamento. Quando verdadeiro, a consulta será planejada e executada, retornando os resultados completos da consulta com as métricas dos estágios de planejamento e execução. |
GetDocumentRequest
A solicitação para Firestore.GetDocument
.
Campos | |
---|---|
name |
Obrigatório. O nome do recurso do documento a ser recebido. Use o formato: |
mask |
Os campos a serem retornados. Se não definido, retorna todos os campos. Se o documento tiver um campo ausente nessa máscara, esse campo não será retornado na resposta. |
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 |
Lê o documento em uma transação. |
read_time |
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 pode ser um carimbo de data/hora de um minuto inteiro nos últimos sete dias. |
ListCollectionIdsRequest
A solicitação para Firestore.ListCollectionIds
.
Campos | |
---|---|
parent |
Obrigatório. O documento pai. Use o formato: |
page_size |
O número máximo de resultados a serem retornados. |
page_token |
Um token de página. Precisa ser um valor de |
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: |
|
read_time |
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. |
ListCollectionIdsResponse
A resposta de Firestore.ListCollectionIds
.
Campos | |
---|---|
collection_ids[] |
Os IDs de coleções. |
next_page_token |
Um token de página que pode ser usado para continuar a lista. |
ListDocumentsRequest
A solicitação para Firestore.ListDocuments
.
Campos | |
---|---|
parent |
Obrigatório. O nome do recurso pai. Use o formato: Por exemplo, |
collection_id |
Opcional. O ID da coleção, relativo a Por exemplo: Isso é opcional e, quando não fornecido, o Firestore listará documentos de todas as coleções no |
page_size |
Opcional. O número máximo de documentos a serem retornados em uma única resposta. O Firestore pode retornar menos que esse valor. |
page_token |
Opcional. Um token de página, recebido de uma resposta Forneça isso para recuperar a página subsequente. Ao paginar, todos os outros parâmetros (exceto |
order_by |
Opcional. A ordem opcional dos documentos a serem retornados. Por exemplo, Isso espelha o |
mask |
Opcional. Os campos a serem retornados. Se não definido, retorna todos os campos. Se um documento tiver um campo ausente nessa máscara, esse campo não será retornado na resposta. |
show_missing |
Se a lista mostrar documentos ausentes. Um documento está ausente 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, Solicitações com |
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 |
Executa a leitura como parte de uma transação já ativa. |
read_time |
Executa 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 pode ser um carimbo de data/hora de um minuto inteiro nos últimos sete dias. |
ListDocumentsResponse
A resposta para Firestore.ListDocuments
.
Campos | |
---|---|
documents[] |
Os documentos encontrados. |
next_page_token |
Um token para recuperar a próxima página de documentos. Se esse campo for omitido, não haverá páginas subsequentes. |
ListenRequest
Uma solicitação de Firestore.Listen
Campos | |
---|---|
database |
Obrigatório. O nome do banco de dados. Use o formato: |
labels |
Os rótulos associados a essa alteração de destino. |
Campo de união target_change . O destino compatível é alterado. target_change pode ser apenas de um dos tipos a seguir: |
|
add_target |
Um destino a ser adicionado a este stream. |
remove_target |
O ID de uma segmentação a ser removida desse fluxo. |
ListenResponse
A resposta para Firestore.Listen
.
Campos | |
---|---|
Campo de união response_type . As respostas compatíveis. response_type pode ser apenas de um dos tipos a seguir: |
|
target_change |
Os destinos foram alterados. |
document_change |
Um |
document_delete |
Um |
document_remove |
Um |
filter |
Um filtro a ser aplicado ao conjunto de documentos retornados anteriormente para o destino especificado. Retornado quando os documentos podem ter sido removidos do destino especificado, mas os documentos exatos são desconhecidos. |
MapValue
Um valor de mapa.
Campos | |
---|---|
fields |
Campos do mapa. As chaves do mapa representam nomes de campo. Os nomes de campo que correspondem à expressão regular |
PartitionQueryRequest
A solicitação para Firestore.PartitionQuery
.
Campos | |
---|---|
parent |
Obrigatório. O nome do recurso pai. Use o formato: |
partition_count |
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. |
page_token |
O valor Por exemplo, duas chamadas subsequentes usando um page_token podem retornar:
Para receber um conjunto de resultados completo ordenado com relação aos resultados da consulta fornecida para PartitionQuery, os conjuntos de resultados devem ser mesclados: cursor A, cursor B, cursor M, cursor Q, cursor U, cursor W |
page_size |
O número máximo de partições a serem retornadas nesta chamada, sujeito a Por exemplo, se |
Campo de união query_type . A consulta a ser particionada. query_type pode ser apenas de um dos tipos a seguir: |
|
structured_query |
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: |
|
read_time |
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. |
PartitionQueryResponse
A resposta para Firestore.PartitionQuery
.
Campos | |
---|---|
partitions[] |
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 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:
Um resultado vazio pode indicar que a consulta tem poucos resultados para ser particionada ou que ela ainda não é compatível com particionamento. |
next_page_token |
Um token de página que pode ser usado para solicitar um conjunto adicional de resultados, até o número especificado por |
PlanSummary
Informações da fase de planejamento da consulta.
Campos | |
---|---|
indexes_used[] |
Os índices selecionados para a consulta. For example: [ {"query_scope": "Collection", "properties": "(foo ASC, name ASC)"}, {"query_scope": "Collection", "properties": "(bar ASC, name ASC)"} ] |
Precondition
Uma pré-condição em um documento, usada para operações condicionais.
Campos | |
---|---|
Campo de união condition_type . O tipo de condição prévia. condition_type pode ser apenas de um dos tipos a seguir: |
|
exists |
Quando definido como |
update_time |
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. |
RollbackRequest
A solicitação para Firestore.Rollback
.
Campos | |
---|---|
database |
Obrigatório. O nome do banco de dados. Use o formato: |
transaction |
Obrigatório. A transação a ser revertida. |
RunAggregationQueryRequest
A solicitação para Firestore.RunAggregationQuery
.
Campos | |
---|---|
parent |
Obrigatório. O nome do recurso pai. Use o formato: |
explain_options |
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: |
|
structured_aggregation_query |
Uma consulta de agregação. |
Campo de união consistency_selector . O modo de consistência da consulta. O padrão é consistência forte. consistency_selector pode ser apenas de um dos tipos a seguir: |
|
transaction |
Execute a agregação em uma transação já ativa. O valor aqui é o ID da transação opaco em que a consulta será executada. |
new_transaction |
Inicia uma nova transação como parte da consulta, assumindo o padrão somente leitura. O novo ID da transação vai ser retornado como a primeira resposta no fluxo. |
read_time |
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 pode ser um carimbo de data/hora de um minuto inteiro nos últimos sete dias. |
RunAggregationQueryResponse
A resposta para Firestore.RunAggregationQuery
.
Campos | |
---|---|
result |
Um único resultado de agregação. Não está presente ao informar progresso parcial. |
transaction |
A transação que foi iniciada como parte desta solicitação. Presente apenas na primeira resposta quando a solicitação é solicitada para iniciar uma nova transação. |
read_time |
A hora em que o resultado agregado foi calculado. Isso sempre aumenta monotonicamente. Nesse caso, há a garantia de que o AggregateResult anterior no fluxo de resultado não muda entre o Se a consulta não retornar resultados, uma resposta com |
explain_metrics |
Métricas de explicação de consulta. Ele só está presente quando o |
RunQueryRequest
A solicitação para Firestore.RunQuery
.
Campos | |
---|---|
parent |
Obrigatório. O nome do recurso pai. Use o formato: |
explain_options |
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: |
|
structured_query |
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. |
new_transaction |
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. |
read_time |
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. |
RunQueryResponse
A resposta para Firestore.RunQuery
.
Campos | |
---|---|
transaction |
A transação que foi iniciada como parte desta solicitação. Só pode ser definido na primeira resposta e apenas se |
document |
Um resultado de consulta, não definido ao relatar progresso parcial. |
read_time |
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 |
skipped_results |
O número de resultados que foram ignorados devido a um deslocamento entre a última resposta e a atual. |
explain_metrics |
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. |
StructuredAggregationQuery
Consulta do Firestore para executar uma agregação em um StructuredQuery
.
Campos | |
---|---|
aggregations[] |
Opcional. Série de agregações que vão ser aplicadas aos resultados da Requer:
|
Campo de união query_type . A consulta de base para agregação. query_type pode ser apenas de um dos tipos a seguir: |
|
structured_query |
Consulta estruturada aninhada. |
Agregação
Define uma agregação que produz um único resultado.
Campos | |
---|---|
alias |
Opcional. Nome opcional do campo em que o resultado da agregação é armazenado. Se não for fornecido, o Firestore escolherá um nome padrão seguindo o formato
se torna:
Requer:
|
Campo de união operator . O tipo de agregação a ser realizada, obrigatório. operator pode ser apenas de um dos tipos a seguir: |
|
count |
Agregador de contagem. |
sum |
Agregador de soma. |
avg |
Agregador médio. |
Méd.
Média dos valores do campo solicitado.
Somente valores numéricos serão agregados. Todos os valores não numéricos, incluindo
NULL
, são ignorados.Se os valores agregados contiverem
NaN
, retornaráNaN
. A matemática do infinito segue os padrões IEEE-754.Se o conjunto de valores agregados estiver vazio, será retornado
NULL
.Sempre retorna o resultado como double.
Campos | |
---|---|
field |
O campo no qual agregar. |
Contagem
Contagem de documentos que correspondem à consulta.
A função de agregação COUNT(*)
opera em todo o documento. Por isso, não requer uma referência de campo.
Campos | |
---|---|
up_to |
Opcional. Restrição opcional para o número máximo de documentos a serem contabilizados. Dessa forma, é possível definir um limite superior para o número de documentos a serem verificados, limitando a latência e o custo. Um valor não especificado é interpretado como "sem limite". Exemplo de alto nível:
Requer:
|
Sum
Soma dos valores do campo solicitado.
Somente valores numéricos serão agregados. Todos os valores não numéricos, incluindo
NULL
, são ignorados.Se os valores agregados contiverem
NaN
, retornaráNaN
. A matemática do infinito segue os padrões IEEE-754.Se o conjunto de valores agregados estiver vazio, retornará 0.
Retorna um número inteiro de 64 bits se todos os números agregados forem inteiros e o resultado da soma não estourar. Caso contrário, o resultado será retornado como double. Mesmo que todos os valores agregados sejam inteiros, o resultado será retornado como duplo se não couber em um número inteiro assinado de 64 bits. Quando isso ocorrer, o valor retornado vai perder a precisão.
Quando ocorre subfluxo, a agregação de ponto flutuante não é determinista. Isso significa que executar a mesma consulta repetidamente sem nenhuma alteração dos valores subjacentes pode produzir resultados um pouco diferentes a cada vez. Nesses casos, os valores devem ser armazenados como números inteiros sobre números de ponto flutuante.
Campos | |
---|---|
field |
O campo no qual agregar. |
StructuredQuery
Uma consulta do Firestore.
Os estágios da consulta são executados na seguinte ordem: 1. de 2. em que 3. selecione 4. order_by + start_at + end_at 5. deslocamento 6. limite
Campos | |
---|---|
select |
Subconjunto opcional dos campos a serem retornados. Ele atua como um |
from[] |
As coleções a serem consultadas. |
where |
O filtro a ser aplicado. |
order_by[] |
A ordem a ser aplicada aos resultados da consulta. O Firestore permite que os autores da chamada forneçam uma ordem completa, uma parcial ou nenhuma ordem. Em todos os casos, o Firestore garante uma ordem estável usando estas regras:
Os campos são anexados com a mesma direção de classificação que o último pedido especificado ou 'ASCENDING' se nenhum pedido tiver sido especificado. Exemplo:
|
start_at |
Um possível prefixo de uma posição no conjunto de resultados em que a consulta será iniciada. A ordem do conjunto de resultados é baseada na cláusula
Os resultados dessa consulta são ordenados por Os cursores podem fazer referência à ordem completa ou a um prefixo da localização, embora não possam referenciar mais campos do que estão no Continuando com o exemplo acima, anexar os seguintes cursores iniciais terá um impacto variável:
Ao contrário de Requer:
|
end_at |
Um possível prefixo de uma posição no conjunto de resultados em que a consulta será encerrada. Isso é semelhante ao Requer:
|
offset |
O número de documentos a serem pulados antes de retornar o primeiro resultado. Isso se aplica após as restrições especificadas por Requer:
|
limit |
O número máximo de resultados a serem retornados. Aplica-se depois de todas as outras restrições. Requer:
|
find_nearest |
Opcional. Uma potencial Pesquisa de vizinhos mais próximos. Aplica-se depois de todos os outros filtros e ordens. Encontra os embeddings vetoriais mais próximos ao vetor de consulta especificado. |
CollectionSelector
Uma seleção de uma coleção, como messages as m1
.
Campos | |
---|---|
collection_id |
O ID da coleção. Quando definido, seleciona apenas as coleções com esse ID. |
all_descendants |
Quando definido como falso, seleciona apenas coleções que são filhas imediatas do |
CompositeFilter
Um filtro que mescla vários outros filtros usando o operador fornecido.
Campos | |
---|---|
op |
Operador para combinar vários filtros. |
filters[] |
Lista de filtros a serem combinados. Requer:
|
Operador
Um operador de filtro composto.
Enums | |
---|---|
OPERATOR_UNSPECIFIED |
Não especificado. Esse valor não pode ser usado. |
AND |
Os documentos precisam atender a todos os filtros combinados. |
OR |
Os documentos precisam atender a pelo menos um dos filtros combinados. |
Direção
Uma direção de classificação.
Enums | |
---|---|
DIRECTION_UNSPECIFIED |
Não especificado. |
ASCENDING |
Crescente. |
DESCENDING |
Decrescente. |
FieldFilter
Um filtro em um campo específico.
Campos | |
---|---|
field |
O campo para filtrar. |
op |
O operador a ser filtrado. |
value |
O valor a ser comparado. |
Operador
Um operador de filtro de campo.
Enums | |
---|---|
OPERATOR_UNSPECIFIED |
Não especificado. Esse valor não pode ser usado. |
LESS_THAN |
O Requer:
|
LESS_THAN_OR_EQUAL |
A Requer:
|
GREATER_THAN |
O Requer:
|
GREATER_THAN_OR_EQUAL |
A Requer:
|
EQUAL |
O field fornecido é igual ao value especificado. |
NOT_EQUAL |
O Requer:
|
ARRAY_CONTAINS |
O field fornecido é uma matriz que contém o value especificado. |
IN |
O Requer:
|
ARRAY_CONTAINS_ANY |
O Requer:
|
NOT_IN |
O valor de Requer:
|
FieldReference
Uma referência a um campo em um documento, por exemplo: stats.operations
.
Campos | |
---|---|
field_path |
Uma referência a um campo em um documento. Requer:
|
Filtrar
Um filtro.
Campos | |
---|---|
Campo de união filter_type . O tipo de filtro. filter_type pode ser apenas de um dos tipos a seguir: |
|
composite_filter |
Um filtro composto. |
field_filter |
Um filtro em um campo do documento. |
unary_filter |
Um filtro que usa exatamente um argumento. |
FindNearest
Configuração de pesquisa de vizinhos mais próximos.
Campos | |
---|---|
vector_field |
Obrigatório. Um campo de vetor indexado para pesquisa. Somente documentos que contêm vetores cuja dimensionalidade corresponde a query_vector podem ser retornados. |
query_vector |
Obrigatório. O vetor de consulta em que estamos pesquisando. Precisa ser um vetor com, no máximo, 2.048 dimensões. |
distance_measure |
Obrigatório. A medida de distância a ser usada, obrigatória. |
limit |
Obrigatório. O número de vizinhos mais próximos a serem retornados. Precisa ser um número inteiro positivo de até 1.000. |
DistanceMeasure
A medida de distância a ser usada na comparação de vetores.
Enums | |
---|---|
DISTANCE_MEASURE_UNSPECIFIED |
Não deve ser definido. |
EUCLIDEAN |
Mede a distância EUCLIDEAN entre os vetores. Consulte Euclidiano para saber mais |
COSINE |
Compara vetores com base no ângulo entre eles, o que permite medir a similaridade que não se baseia na magnitude dos vetores. Recomendamos o uso de DOT_PRODUCT com vetores normalizados unitários em vez da distância de COSINE, que é matematicamente equivalente com melhor desempenho. Consulte Semelhança de cossenos para saber mais. |
DOT_PRODUCT |
Semelhante ao cosseno, mas é afetado pela magnitude dos vetores. Consulte Produto escalar para saber mais. |
Pedido
Um pedido em um campo.
Campos | |
---|---|
field |
O campo pelo qual ordenar. |
direction |
A direção de ordenação. O valor padrão é |
Projeção
A projeção dos campos do documento a serem retornados.
Campos | |
---|---|
fields[] |
Os campos a serem retornados. Se estiver vazio, todos os campos serão retornados. Para retornar apenas o nome do documento, use |
UnaryFilter
Um filtro com um único operando.
Campos | |
---|---|
op |
O operador unário a ser aplicado. |
Campo de união operand_type . O argumento para o filtro. operand_type pode ser apenas de um dos tipos a seguir: |
|
field |
O campo em que o operador será aplicado. |
Operador
Um operador unário.
Enums | |
---|---|
OPERATOR_UNSPECIFIED |
Não especificado. Esse valor não pode ser usado. |
IS_NAN |
O field fornecido é igual a NaN . |
IS_NULL |
O field fornecido é igual a NULL . |
IS_NOT_NAN |
O Requer:
|
IS_NOT_NULL |
O Requer:
|
Objetivo
Uma especificação de um conjunto de documentos a serem detectados.
Campos | |
---|---|
target_id |
É o ID de destino que identifica o destino no fluxo. Precisa ser um número positivo e diferente de zero. Se Se o cliente enviar várias solicitações Se |
once |
Se o destino precisa ser removido quando estiver atual e consistente. |
expected_count |
O número de documentos que corresponderam à consulta por último no token de currículo ou no momento de leitura. Esse valor só é relevante quando um |
Campo de união target_type . O tipo de destino a ser detectado. target_type pode ser apenas de um dos tipos a seguir: |
|
query |
Um destino especificado por uma consulta. |
documents |
Um destino especificado por um conjunto de nomes de documentos. |
Campo de união Se especificado, somente os documentos correspondentes que foram atualizados APÓS o |
|
resume_token |
Um token de currículo de um Não é possível usar um token de currículo com um destino diferente e pode haver falha. |
read_time |
Comece a ouvir depois de um Neste momento, o cliente precisa saber o estado dos documentos correspondentes. |
DocumentsTarget
Um destino especificado por um conjunto de nomes de documentos.
Campos | |
---|---|
documents[] |
Os nomes dos documentos a serem recuperados. Use o formato: |
QueryTarget
Um destino especificado por uma consulta.
Campos | |
---|---|
parent |
O nome do recurso pai. Use o formato: |
Campo de união query_type . A consulta a ser executada. query_type pode ser apenas de um dos tipos a seguir: |
|
structured_query |
Uma consulta estruturada. |
TargetChange
Os objetivos monitorados mudaram.
Campos | |
---|---|
target_change_type |
O tipo de alteração que ocorreu. |
target_ids[] |
Os IDs dos destinos que foram alterados. Se estiver vazio, a mudança vai ser aplicada a todos os destinos. A ordem dos IDs de destino não foi definida. |
cause |
O erro que resultou nessa alteração, se aplicável. |
resume_token |
Um token que pode ser usado para retomar o stream para o Não é definido em cada alteração de meta. |
read_time |
O O stream vai enviar um É garantido que o |
TargetChangeType
O tipo de alteração
Enums | |
---|---|
NO_CHANGE |
Nenhuma mudança foi feita. Usado apenas para enviar um resume_token atualizado. |
ADD |
Os destinos foram adicionados. |
REMOVE |
Os destinos foram removidos. |
CURRENT |
Os destinos refletem todas as alterações confirmadas antes da adição deles ao stream. Ele será enviado depois ou com um Os listeners podem aguardar essa mudança se quiserem a semântica de leitura após gravação. |
RESET |
Os destinos foram redefinidos, e um novo estado inicial para eles será retornado nas próximas mudanças. Após a conclusão do estado inicial, |
TransactionOptions
Opções para criar uma nova transação.
Campos | |
---|---|
Campo de união mode . O modo da transação. mode pode ser apenas de um dos tipos a seguir: |
|
read_only |
A transação só pode ser usada para operações de leitura. |
read_write |
A transação pode ser usada para operações de leitura e gravação. |
ReadOnly
Opções para uma transação que só pode ser usada para ler documentos.
Campos | |
---|---|
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: |
|
read_time |
Lê os documentos 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 pode ser um carimbo de data/hora de um minuto inteiro nos últimos sete dias. |
ReadWrite
Opções para uma transação que podem ser usadas para ler e gravar documentos.
O Firestore não permite que solicitações de autenticação de terceiros criem transações de leitura/gravação.
Campos | |
---|---|
retry_transaction |
Uma transação opcional para nova tentativa. |
UpdateDocumentRequest
A solicitação para Firestore.UpdateDocument
.
Campos | |
---|---|
document |
Obrigatório. O documento atualizado. Cria o documento se ele ainda não existir. |
update_mask |
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 ausentes no documento de entrada, são excluídos do documento no servidor. |
mask |
Os campos a serem retornados. Se não definido, retorna todos os campos. Se o documento tiver um campo ausente nessa máscara, esse campo não será retornado na resposta. |
current_document |
Uma condição prévia opcional no documento. A solicitação falhará se isso for definido e não for atendido pelo documento de destino. |
Valor
Uma mensagem que pode conter qualquer um dos tipos de valor compatíveis.
Campos | |
---|---|
Campo de união value_type . Precisa ter um valor definido. value_type pode ser apenas de um dos tipos a seguir: |
|
null_value |
Um valor nulo. |
boolean_value |
Um valor booleano. |
integer_value |
Um valor inteiro. |
double_value |
Um valor duplo. |
timestamp_value |
Um valor de carimbo de data/hora. Precisão apenas em microssegundos. Quando armazenadas, qualquer precisão adicional é arredondada para baixo. |
string_value |
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_value |
Um valor de bytes. Não pode exceder 1 MiB a 89 bytes. Somente os primeiros 1.500 bytes são considerados nas consultas. |
reference_value |
Uma referência a um documento. Por exemplo, |
geo_point_value |
Um valor do ponto geográfico que representa um ponto na superfície da Terra. |
array_value |
Um valor de matriz. Não pode conter diretamente outro valor de matriz, embora possa conter um mapa que contenha outra matriz. |
map_value |
Um valor de mapa. |
Gravar
Uma gravação em um documento.
Campos | |
---|---|
update_mask |
Os campos a serem atualizados nessa gravação. Este campo só pode ser definido quando a operação é |
update_transforms[] |
As transformações a serem executadas após a atualização. Este campo só pode ser definido quando a operação é |
current_document |
Uma condição prévia opcional no documento. A gravação falhará se isso for definido e não atendido pelo documento de destino. |
Campo de união operation . A operação a ser executada. operation pode ser apenas de um dos tipos a seguir: |
|
update |
Um documento para gravar. |
delete |
Um nome de documento a ser excluído. Use o formato: |
transform |
Aplica uma transformação a um documento. |
WriteRequest
A solicitação para Firestore.Write
.
A primeira solicitação cria um stream ou retoma outro existente a partir de um token.
Ao criar um novo stream, o servidor responde com uma resposta contendo apenas um ID e um token, para uso na próxima solicitação.
Ao retomar um stream, o servidor primeiro transmite as respostas depois do token fornecido e, em seguida, uma resposta contendo apenas um token atualizado, para uso na próxima solicitação.
Campos | |
---|---|
database |
Obrigatório. O nome do banco de dados. Use o formato: |
stream_id |
O ID do fluxo de gravação a ser retomado. Só é possível definir isso na primeira mensagem. Quando deixado em branco, um novo stream de gravação é criado. |
writes[] |
As gravações a serem aplicadas. Sempre executado atomicamente e em ordem. Ele precisa estar vazio na primeira solicitação. Ele pode estar vazio na última solicitação. Ele não pode ficar vazio em todas as outras solicitações. |
stream_token |
Um token de stream que foi enviado anteriormente pelo servidor. O cliente precisa definir esse campo como o token do O servidor pode fechar o stream se houver muitas respostas não confirmadas. Não defina este campo ao criar um novo stream. Para retomar uma transmissão em um ponto específico, defina este campo e o campo Não defina este campo ao criar um novo stream. |
labels |
Rótulos associados a esta solicitação de gravação. |
WriteResponse
A resposta para Firestore.Write
.
Campos | |
---|---|
stream_id |
O ID do fluxo. Definido apenas na primeira mensagem, quando uma nova transmissão foi criada. |
stream_token |
Um token que representa a posição da resposta no stream. Isso pode ser usado por um cliente para retomar o stream neste ponto. Este campo está sempre definido. |
write_results[] |
O resultado da aplicação das gravações. O resultado i-th write corresponde à i-th write na solicitação. |
commit_time |
A hora em que a confirmação ocorreu. Qualquer leitura com um |
WriteResult
Resultado da aplicação de uma gravação.
Campos | |
---|---|
update_time |
O horário da última atualização do documento após a aplicação da gravação. Não definido após um Se a gravação não tiver alterado o documento, esse será o update_time anterior. |
transform_results[] |
Os resultados da aplicação de cada |