Package google.firestore.v1

map<string, Value>

Il risultato delle funzioni di aggregazione, ad esempio COUNT(*) AS total_docs.

La chiave è la chiave alias assegnata alla funzione di aggregazione al momento dell'input e le dimensioni di questa mappa corrispondono al numero di funzioni di aggregazione nella query.

Value

Valori nell'array.

string

obbligatorio. Il nome del database. Nel formato: projects/{project_id}/databases/{database_id}.

string

I nomi dei documenti da recuperare. Nel formato: projects/{project_id}/databases/{database_id}/documents/{document_path}. La richiesta avrà esito negativo se uno qualsiasi del documento non è una risorsa secondaria del database specificato. I nomi duplicati verranno eliminati.

DocumentMask

I campi da restituire. Se non viene configurato, restituisce tutti i campi.

Se un documento ha un campo che non è presente in questa maschera, quel campo non verrà restituito nella risposta.

bytes

Legge i documenti di una transazione.

TransactionOptions

Avvia una nuova transazione e legge i documenti. Il valore predefinito è una transazione di sola lettura. Il nuovo ID transazione verrà restituito come prima risposta nel flusso.

Timestamp

Legge i documenti così come erano al momento specificato.

Deve essere un timestamp con precisione in microsecondi risalente all'ultima ora oppure, se il recupero point-in-time è abilitato, può essere anche un timestamp di un minuto intero compreso negli ultimi 7 giorni.

bytes

La transazione avviata nell'ambito di questa richiesta. Verrà impostato solo nella prima risposta e solo se BatchGetDocumentsRequest.new_transaction è stato impostato nella richiesta.

Timestamp

L'ora in cui il documento è stato letto. La variazione potrebbe aumentare monoticamente. In questo caso, infatti, i documenti precedenti nel flusso dei risultati sono garantiti che non siano cambiati tra il tempo di lettura e quello attuale.

Document

Un documento richiesto.

string

Un nome documento che è stato richiesto, ma non esiste. Nel formato: projects/{project_id}/databases/{database_id}/documents/{document_path}.

string

obbligatorio. Il nome del database. Nel formato: projects/{project_id}/databases/{database_id}.

Write

Le operazioni di scrittura da applicare.

Il metodo non si applica a livello atomico e non garantisce l'ordinamento. Ogni scrittura ha esito positivo o negativo in modo indipendente. Non puoi scrivere sullo stesso documento più di una volta per richiesta.

map<string, string>

Etichette associate alla scrittura in batch.

WriteResult

Il risultato dell'applicazione delle scritture.

Questo risultato di scrittura i-th corrisponde alla scrittura i-esima nella richiesta.

Status

Lo stato delle scritture.

Questo stato di scrittura i-esima corrisponde alla scrittura i-esima nella richiesta.

string

obbligatorio. Il nome del database. Nel formato: projects/{project_id}/databases/{database_id}.

TransactionOptions

Le opzioni per la transazione. Il valore predefinito è una transazione di lettura-scrittura.

bytes

La transazione avviata.

bytes

I byte che codificano la sequenza di bit. Può avere una lunghezza pari a zero.

int32

Il numero di bit dell'ultimo byte in bitmap da ignorare come "spaziatura interna". Se la lunghezza di bitmap è zero, questo valore deve essere 0. In caso contrario, questo valore deve essere compreso tra 0 e 7 inclusi.

BitSequence

I dati del filtro Bloom.

int32

Il numero di hash utilizzati dall'algoritmo.

string

obbligatorio. Il nome del database. Nel formato: projects/{project_id}/databases/{database_id}.

Write

Le operazioni di scrittura da applicare.

Esegui sempre a livello atomico e in ordine.

bytes

Se impostato, applica tutte le scritture in questa transazione ed esegue il commit.

WriteResult

Il risultato dell'applicazione delle scritture.

Questo risultato di scrittura i-th corrisponde alla scrittura i-esima nella richiesta.

Timestamp

L'ora in cui si è verificato il commit. Qualsiasi lettura con un valore read_time uguale o maggiore è garantito per vedere gli effetti del commit.

string

obbligatorio. La risorsa padre. Ad esempio: projects/{project_id}/databases/{database_id}/documents o projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}

string

obbligatorio. L'ID raccolta, relativo a parent, dell'elenco. Ad esempio: chatrooms.

string

L'ID documento assegnato dal cliente da utilizzare per questo documento.

Campo facoltativo. Se non specificato, il servizio verrà assegnato un ID.

Document

obbligatorio. Il documento da creare. Non è necessario impostare name.

DocumentMask

I campi da restituire. Se non viene configurato, restituisce tutti i campi.

Se il documento ha un campo che non è presente in questa maschera, quel campo non verrà restituito nella risposta.

Value

I valori che rappresentano una posizione, nell'ordine in cui appaiono in ordine per clausola di una query.

Può contenere meno valori di quelli specificati nell'ordine per clausola.

bool

Se la posizione è immediatamente precedente o immediatamente successiva ai valori specificati, in base all'ordinamento definito dalla query.

string

obbligatorio. Il nome della risorsa del documento da eliminare. Nel formato: projects/{project_id}/databases/{database_id}/documents/{document_path}.

Precondition

Una condizione preliminare facoltativa sul documento. La richiesta avrà esito negativo se questa impostazione viene impostata e non viene soddisfatta dal documento di destinazione.

string

Il nome della risorsa del documento, ad esempio projects/{project_id}/databases/{database_id}/documents/{document_path}.

map<string, Value>

Timestamp

Solo output. L'ora in cui è stato creato il documento.

Questo valore aumenta monotonicamente quando un documento viene eliminato e poi ricreato. Può anche essere confrontato con i valori di altri documenti e con l'read_time di una query.

Timestamp

Solo output. L'ora dell'ultima modifica del documento.

Questo valore viene inizialmente impostato su create_time e poi aumenta in modo monotonico a ogni modifica al documento. Può anche essere confrontato con i valori di altri documenti e con l'read_time di una query.

Document

Il nuovo stato dell'Document.

Se mask è impostato, contiene solo i campi che sono stati aggiornati o aggiunti.

int32

Un insieme di ID target dei target che corrispondono a questo documento.

int32

Un insieme di ID target per i target che non corrispondono più a questo documento.

string

Il nome della risorsa Document che è stata eliminata.

int32

Un insieme di ID target per i target che in precedenza corrispondevano a questa entità.

Timestamp

Il timestamp di lettura in cui è stata osservata l'eliminazione.

Maggiore o uguale al valore commit_time dell'eliminazione.

string

L'elenco dei percorsi di campo nella maschera. Consulta Document.fields per un riferimento alla sintassi dei percorsi dei campi.

string

Il nome della risorsa Document che non è più visibile.

int32

Un insieme di ID target per i target che corrispondono in precedenza a questo documento.

Timestamp

Il timestamp di lettura in cui è stata osservata la rimozione.

Maggiore o uguale al commit_time della modifica/eliminazione/rimozione.

string

Il nome del documento da trasformare.

FieldTransform

L'elenco delle trasformazioni da applicare ai campi del documento, in ordine. Questo campo non deve essere vuoto.

string

Il percorso del campo. Consulta Document.fields per il riferimento alla sintassi del percorso del campo.

ServerValue

Imposta il campo sul valore del server specificato.

Value

Aggiunge il valore specificato al valore attuale del campo.

Deve essere un numero intero o un valore doppio. Se il campo non è un numero intero o un doppio oppure il campo non esiste ancora, la trasformazione lo imposterà sul valore specificato. Se uno dei valori specificati o quelli del campo corrente sono doppi, entrambi verranno interpretati come doppi. L'aritmetica doppia e la rappresentazione di valori doppi seguono la semantica dello standard IEEE 754. In caso di overflow di numero intero positivo/negativo, il campo viene risolto nel numero intero positivo/negativo di magnitudo più grande.

Value

Consente di impostare il campo al massimo del valore attuale e del valore specificato.

Deve essere un numero intero o un valore doppio. Se il campo non è un numero intero o un doppio oppure il campo non esiste ancora, la trasformazione lo imposterà sul valore specificato. Se viene applicata un'operazione massima in cui il campo e il valore di input sono di tipo misto (ovvero uno è un numero intero e uno è il doppio), il campo assume il tipo dell'operando più grande. Se gli operandi sono equivalenti (ad es. 3 e 3.0), il campo non viene modificato. 0, 0,0 e -0,0 sono tutti zero. Il valore massimo tra un valore memorizzato e uno di input pari a zero è sempre il valore memorizzato. Il massimo di qualsiasi valore numerico x e NaN è NaN.

Value

Imposta il campo al minimo del suo valore attuale e del valore specificato.

Deve essere un numero intero o un valore doppio. Se il campo non è un numero intero o un doppio oppure il campo non esiste ancora, la trasformazione lo imposterà sul valore di input. Se viene applicata un'operazione minima in cui il campo e il valore di input sono di tipo misto (ovvero uno è un numero intero e uno è un doppio), il campo assume il tipo dell'operando più piccolo. Se gli operandi sono equivalenti (ad es. 3 e 3.0), il campo non viene modificato. 0, 0,0 e -0,0 sono tutti zero. Il valore minimo tra un valore memorizzato e uno di input pari a zero è sempre il valore memorizzato. Il minimo di qualsiasi valore numerico x e NaN è NaN.

ArrayValue

Aggiungi gli elementi specificati in ordine se non sono già presenti nel valore del campo corrente. Se il campo non è un array o se il campo non esiste ancora, viene prima impostato sull'array vuoto.

Numeri equivalenti di tipi diversi (ad es. 3L e 3,0) sono considerati uguali quando si controlla se un valore è mancante. NaN è uguale a NaN e null è uguale a null. Se l'input contiene più valori equivalenti, verrà preso in considerazione solo il primo.

Il valore Transform_result corrispondente sarà il valore null.

ArrayValue

Rimuovi tutti gli elementi specificati dall'array nel campo. Se il campo non è un array o se il campo non esiste ancora, viene impostato sull'array vuoto.

I numeri equivalenti dei diversi tipi (ad es. 3L e 3.0) sono considerati uguali quando decidi se un elemento deve essere rimosso. NaN è uguale a NaN e null è uguale a null. Verranno rimossi tutti i valori equivalenti se sono presenti duplicati.

Il valore Transform_result corrispondente sarà il valore null.

int64

Numero totale di risultati restituiti, inclusi documenti, proiezioni, risultati dell'aggregazione e chiavi.

Duration

Tempo totale per l'esecuzione della query nel backend.

int64

Operazioni di lettura fatturabili totali.

Struct

Statistiche di debug relative all'esecuzione della query. Tieni presente che le statistiche di debug sono soggette a variazioni man mano che Firestore si evolve. It could include: { "indexes_entries_scanned": "1000", "documents_scanned": "20", "billing_details" : { "documents_billable": "20", "index_entries_billable": "1000", "min_query_cost": "0" } }

int32

L'ID target a cui si applica il filtro.

int32

Il numero totale di documenti che corrispondono a target_id.

Se è diverso dal numero di documenti nel client che corrispondono, il cliente deve determinare manualmente quali documenti non corrispondono più al target.

Il client può utilizzare il filtro unchanged_names Bloom per facilitare questa determinazione, testando TUTTI i nomi dei documenti rispetto al filtro. Se il nome del documento NON è presente nel filtro, significa che il documento non corrisponde più alla destinazione.

BloomFilter

Un filtro Bloom che, nonostante il nome, contiene le codifiche di byte UTF-8 dei nomi delle risorse di TUTTI i documenti che corrispondono a target_id, nel formato projects/{project_id}/databases/{database_id}/documents/{document_path}.

Questo filtro Bloom può essere omesso a discrezione del server, ad esempio se si ritiene che il client non lo utilizzi o se è troppo costoso da calcolare o trasmettere. I client devono gestire agevolmente l'assenza di questo campo tornando alla logica utilizzata prima che questo campo esistesse, ovvero devono aggiungere nuovamente la destinazione senza un token di ripristino per capire quali documenti nella cache del client non sono sincronizzati.

PlanSummary

Informazioni sulla fase di pianificazione della query.

ExecutionStats

Statistiche aggregate relative all'esecuzione della query. Presente solo quando ExplainOptions.analyze è impostato su true.

bool

Campo facoltativo. Se eseguire questa query.

Se il valore è false (valore predefinito), la query viene pianificata e vengono restituite solo le metriche delle fasi di pianificazione.

Se il valore è true, la query verrà pianificata ed eseguita, restituendo i risultati completi della query insieme alle metriche della fase di pianificazione ed esecuzione.

string

obbligatorio. Il nome della risorsa del documento da recuperare. Nel formato: projects/{project_id}/databases/{database_id}/documents/{document_path}.

DocumentMask

I campi da restituire. Se non viene configurato, restituisce tutti i campi.

Se il documento ha un campo che non è presente in questa maschera, quel campo non verrà restituito nella risposta.

bytes

Legge il documento in una transazione.

Timestamp

Legge la versione del documento nel momento specificato.

Deve essere un timestamp con precisione in microsecondi risalente all'ultima ora oppure, se il recupero point-in-time è abilitato, può essere anche un timestamp di un minuto intero compreso negli ultimi 7 giorni.

string

obbligatorio. Il documento principale. Nel formato: projects/{project_id}/databases/{database_id}/documents/{document_path}. Ad esempio: projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

int32

Il numero massimo di risultati da restituire.

string

Un token di pagina. Deve essere un valore compreso tra ListCollectionIdsResponse.

Timestamp

Legge i documenti così come erano al momento specificato.

Deve essere un timestamp con precisione in microsecondi risalente all'ultima ora oppure, se il recupero point-in-time è abilitato, può essere anche un timestamp di un minuto intero compreso negli ultimi 7 giorni.

string

Gli ID raccolta.

string

Un token di pagina che può essere utilizzato per continuare l'elenco.

string

obbligatorio. Il nome della risorsa padre. Nel formato: projects/{project_id}/databases/{database_id}/documents o projects/{project_id}/databases/{database_id}/documents/{document_path}.

Ad esempio: projects/my-project/databases/my-database/documents o projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

string

Campo facoltativo. L'ID raccolta, relativo a parent, dell'elenco.

Ad esempio: chatrooms o messages.

Questo campo è facoltativo e, se non viene fornito, Firestore elencherà i documenti di tutte le raccolte che rientrano nell'attributo parent fornito.

int32

Campo facoltativo. Il numero massimo di documenti da restituire in una singola risposta.

Firestore potrebbe restituire un numero inferiore a questo valore.

string

Campo facoltativo. Un token di pagina, ricevuto da una precedente risposta ListDocuments.

Specifica questo valore per recuperare la pagina successiva. Durante l'impaginazione, tutti gli altri parametri (ad eccezione di page_size) devono corrispondere ai valori impostati nella richiesta che ha generato il token della pagina.

string

Campo facoltativo. L'ordine facoltativo dei documenti da restituire.

Ad esempio: priority desc, __name__ desc.

Questo rispecchia il valore ORDER BY utilizzato nelle query di Firestore, ma in una rappresentazione stringa. Se non sono presenti, i documenti vengono ordinati in base a __name__ ASC.

DocumentMask

Campo facoltativo. I campi da restituire. Se non viene configurato, restituisce tutti i campi.

Se un documento ha un campo che non è presente in questa maschera, quel campo non verrà restituito nella risposta.

bool

Indica se nell'elenco devono essere presenti documenti mancanti.

Un documento non esiste se non esiste, ma sono presenti documenti secondari nidificati. Se il valore è true, i documenti mancanti verranno restituiti con una chiave, ma non avranno campi, create_time o update_time impostati.

Le richieste con show_missing non possono specificare where o order_by.

bytes

Esegui la lettura come parte di una transazione già attiva.

Timestamp

Esegui la lettura all'ora indicata.

Deve essere un timestamp con precisione in microsecondi risalente all'ultima ora oppure, se il recupero point-in-time è abilitato, può essere anche un timestamp di un minuto intero compreso negli ultimi 7 giorni.

Document

I documenti trovati.

string

Un token per recuperare la pagina successiva dei documenti.

Se questo campo viene omesso, non verranno visualizzate altre pagine.

string

obbligatorio. Il nome del database. Nel formato: projects/{project_id}/databases/{database_id}.

map<string, string>

Etichette associate a questa modifica della destinazione.

Target

Un target da aggiungere a questo stream.

int32

L'ID di un target da rimuovere dallo stream.

TargetChange

Gli obiettivi sono cambiati.

DocumentChange

Un Document è cambiato.

DocumentDelete

È stato eliminato un elemento Document.

DocumentRemove

Un elemento Document è stato rimosso da un target (perché non è più pertinente per tale target).

ExistenceFilter

Un filtro da applicare all'insieme di documenti restituiti in precedenza per il target specificato.

Errore restituito quando i documenti potrebbero essere stati rimossi dalla destinazione specificata, ma i documenti esatti sono sconosciuti.

map<string, Value>

I campi della mappa.

Le chiavi della mappa rappresentano i nomi dei campi. I nomi dei campi corrispondenti all'espressione regolare __.*__ sono riservati. I nomi di campi riservati sono vietati, tranne in alcuni contesti documentati. Le chiavi di mappa, rappresentate come UTF-8, non devono superare i 1500 byte e non possono essere vuote.

string

obbligatorio. Il nome della risorsa padre. Nel formato: projects/{project_id}/databases/{database_id}/documents. I nomi delle risorse del documento non sono supportati; è possibile specificare solo i nomi delle risorse di database.

int64

Il numero massimo di punti di partizione desiderato. Le partizioni possono essere restituite su più pagine di risultati. Il numero deve essere positivo. Il numero effettivo di partizioni restituite potrebbe essere inferiore.

Ad esempio, questo valore potrebbe essere impostato su uno in meno rispetto al numero di query parallele da eseguire o, durante l'esecuzione di un job di pipeline di dati, su uno in meno rispetto al numero di worker o istanze di calcolo disponibili.

string

Il valore next_page_token restituito da una chiamata precedente a PartitionQuery che può essere utilizzato per ottenere un ulteriore insieme di risultati. L'ordinamento tra i vari insiemi di risultati non è garantito. Pertanto, l'utilizzo di più insiemi di risultati richiederà l'unione dei diversi insiemi di risultati.

Ad esempio, due chiamate successive che utilizzano un page_token potrebbero restituire:

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

Per ottenere un set di risultati completo ordinato rispetto ai risultati della query fornita a PartitionQuery, gli insiemi di risultati devono essere uniti: cursore A, cursore B, cursore M, cursore Q, cursore U, cursore W

int32

Il numero massimo di partizioni da restituire in questa chiamata, soggetto a partition_count.

Ad esempio, se partition_count = 10 e page_size = 8, la prima chiamata a PartitionQuery restituirà fino a 8 partizioni e un next_page_token se sono presenti più risultati. Una seconda chiamata a PartitionQuery restituirà fino a 2 partizioni, per completare il totale di 10 specificate in partition_count.

StructuredQuery

Una query strutturata. La query deve specificare la raccolta con tutti i discendenti ed essere ordinata in base al nome in ordine crescente. Altri filtri, Ordina per, limiti, offset e cursori di inizio e fine non sono supportati.

Timestamp

Legge i documenti così come erano al momento specificato.

Deve essere un timestamp con precisione in microsecondi risalente all'ultima ora oppure, se il recupero point-in-time è abilitato, può essere anche un timestamp di un minuto intero compreso negli ultimi 7 giorni.

Cursor

Risultati del partizionamento. Ogni partizione è un punto di suddivisione che può essere utilizzato da RunQuery come punto iniziale o finale per i risultati della query. Le richieste RunQuery devono essere effettuate con la stessa query fornita a questa richiesta PartitionQuery. I cursori di partizione verranno ordinati secondo lo stesso ordine dei risultati della query fornita a PartitionQuery.

Ad esempio, se una richiesta PartitionQuery restituisce i cursori di partizione A e B, l'esecuzione delle tre query seguenti restituirà l'intero set di risultati della query originale:

• query, end_at A
• query, inizio_da A, fine_at B
• query, start_at B

Un risultato vuoto potrebbe indicare che la query ha un numero insufficiente di risultati per essere partizionata o che la query non è ancora supportata per il partizionamento.

string

Un token di pagina che può essere utilizzato per richiedere un insieme aggiuntivo di risultati, fino al numero specificato da partition_count nella richiesta PartitionQuery. Se vuoto, non ci sono altri risultati.

Struct

Gli indici selezionati per la query. For example: [ {"query_scope": "Collection", "properties": "(foo ASC, name ASC)"}, {"query_scope": "Collection", "properties": "(bar ASC, name ASC)"} ]

bool

Se impostato su true, il documento di destinazione deve esistere. Se impostato su false, il documento di destinazione non deve esistere.

Timestamp

Una volta impostato, il documento di destinazione deve esistere ed essere stato aggiornato l'ultima volta a quella data. Il timestamp deve essere allineato in microsecondi.

string

obbligatorio. Il nome del database. Nel formato: projects/{project_id}/databases/{database_id}.

bytes

obbligatorio. La transazione di cui eseguire il rollback.

string

obbligatorio. Il nome della risorsa padre. Nel formato: projects/{project_id}/databases/{database_id}/documents o projects/{project_id}/databases/{database_id}/documents/{document_path}. Ad esempio: projects/my-project/databases/my-database/documents o projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

ExplainOptions

Campo facoltativo. Spiega le opzioni della query. Se impostato, verranno restituite ulteriori statistiche sulle query. In caso contrario, verranno restituiti solo i risultati della query.

StructuredAggregationQuery

Una query di aggregazione.

bytes

Eseguire l'aggregazione in una transazione già attiva.

Il valore qui è l'ID transazione opaco in cui eseguire la query.

TransactionOptions

Avvia una nuova transazione come parte della query. L'impostazione predefinita è di sola lettura.

Il nuovo ID transazione verrà restituito come prima risposta nel flusso.

Timestamp

Esegue la query al timestamp specificato.

Deve essere un timestamp con precisione in microsecondi risalente all'ultima ora oppure, se il recupero point-in-time è abilitato, può essere anche un timestamp di un minuto intero compreso negli ultimi 7 giorni.

AggregationResult

Un singolo risultato dell'aggregazione.

Non presente quando segnali l'avanzamento parziale.

bytes

La transazione avviata nell'ambito di questa richiesta.

Presente solo nella prima risposta quando la richiesta ha richiesto di avviare una nuova transazione.

Timestamp

L'ora in cui è stato calcolato il risultato aggregato. Questo valore aumenta sempre in modo monotonico; in questo caso, i valori di AggregationResult precedente nel flusso di risultati sono garantiti che non siano cambiati tra l'elemento read_time e questo.

Se la query non restituisce risultati, verrà inviata una risposta con read_time e nessun result, che rappresenta il momento in cui è stata eseguita la query.

ExplainMetrics

La query spiega le metriche. È presente solo quando viene fornito il RunAggregationQueryRequest.explain_options e viene inviato solo una volta con l'ultima risposta nello stream.

string

obbligatorio. Il nome della risorsa padre. Nel formato: projects/{project_id}/databases/{database_id}/documents o projects/{project_id}/databases/{database_id}/documents/{document_path}. Ad esempio: projects/my-project/databases/my-database/documents o projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

ExplainOptions

Campo facoltativo. Spiega le opzioni della query. Se impostato, verranno restituite ulteriori statistiche sulle query. In caso contrario, verranno restituiti solo i risultati della query.

StructuredQuery

Una query strutturata.

bytes

Eseguire la query all'interno di una transazione già attiva.

Il valore qui è l'ID transazione opaco in cui eseguire la query.

TransactionOptions

Avvia una nuova transazione e legge i documenti. Il valore predefinito è una transazione di sola lettura. Il nuovo ID transazione verrà restituito come prima risposta nel flusso.

Timestamp

Legge i documenti così come erano al momento specificato.

Deve essere un timestamp con precisione in microsecondi risalente all'ultima ora oppure, se il recupero point-in-time è abilitato, può essere anche un timestamp di un minuto intero compreso negli ultimi 7 giorni.

bytes

La transazione avviata nell'ambito di questa richiesta. Può essere impostato solo nella prima risposta e solo se nella richiesta è stato impostato RunQueryRequest.new_transaction. Se impostato, non verranno impostati altri campi in questa risposta.

Document

Risultato della query, non impostato quando segnali l'avanzamento parziale.

Timestamp

L'ora in cui il documento è stato letto. Questo valore potrebbe aumentare monotonicamente; in questo caso, i documenti precedenti nel flusso di risultati sono garantiti che non siano cambiati tra il relativo read_time e questo.

Se la query non restituisce risultati, verrà inviata una risposta con read_time e nessun document, che rappresenta il momento in cui è stata eseguita la query.

int32

Il numero di risultati che sono stati ignorati a causa di un offset tra l'ultima risposta e la risposta corrente.

ExplainMetrics

La query spiega le metriche. È presente solo quando viene fornito il RunQueryRequest.explain_options e viene inviato solo una volta con l'ultima risposta nello stream.

bool

Se presente, Firestore ha completato completamente la richiesta e non verranno restituiti altri documenti.

Aggregation

Campo facoltativo. Serie di aggregazioni da applicare ai risultati di structured_query.

Richiede:

• Da un minimo di una a un massimo di cinque aggregazioni per query.

StructuredQuery

Query strutturata nidificata.

string

Campo facoltativo. Nome facoltativo del campo in cui archiviare il risultato dell'aggregazione.

Se non viene specificato, Firestore sceglierà un nome predefinito nel formato field_<incremental_id++>. Ad esempio:

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 (
  ...
);

diventa:

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 (
  ...
);

Richiede:

• Deve essere univoco in tutti gli alias di aggregazione.
• Rispetta le limitazioni di document field name.

Count

Conteggio aggregatore.

Sum

Somma aggregatore.

Avg

Aggregatore medio.

FieldReference

Il campo in base al quale aggregare.

Int64Value

Campo facoltativo. Vincolo facoltativo al numero massimo di documenti da conteggiare.

Ciò fornisce un modo per impostare un limite superiore per il numero di documenti da scansionare, limitando la latenza e il costo.

Un valore non specificato viene interpretato come nessun limite.

Esempio generale:

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

Richiede:

• Deve essere maggiore di zero se presente.

FieldReference

Il campo in base al quale aggregare.

Projection

Sottoinsieme facoltativo dei campi da restituire.

Agisce come DocumentMask per i documenti restituiti da una query. Se non impostato, presuppone che il chiamante voglia restituire tutti i campi.

CollectionSelector

Le raccolte su cui eseguire una query.

Filter

Il filtro da applicare.

Order

L'ordine da applicare ai risultati della query.

Firestore consente ai chiamanti di fornire un ordinamento completo, parziale o nessun ordinamento. In tutti i casi, Firestore garantisce un ordinamento stabile tramite le seguenti regole:

• order_by è obbligatorio per fare riferimento a tutti i campi utilizzati con un filtro di disuguaglianza.
• Tutti i campi che devono essere in order_by, ma non sono già presenti, vengono aggiunti in ordine lessicografico del nome del campo.
• Se un ordine su __name__ non è specificato, viene aggiunto per impostazione predefinita.

Ai campi viene aggiunta la stessa direzione di ordinamento dell'ultimo ordine specificato, oppure "ASCENDENTE" se non è stato specificato alcun ordine. Ad esempio:

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

Cursor

Un potenziale prefisso di una posizione nel set di risultati da cui iniziare la query.

L'ordine del set di risultati si basa sulla clausola ORDER BY della query originale.

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

I risultati di questa query sono ordinati per (b ASC, __name__ ASC).

I cursori possono fare riferimento all'ordine completo o a un prefisso della posizione, anche se non possono fare riferimento a più campi rispetto a quelli dell'elemento ORDER BY fornito.

Proseguendo con l'esempio precedente, l'aggiunta dei seguenti cursori di avvio avrà un impatto diverso:

• START BEFORE (2, /k/123): avvia la query subito prima di a = 1 AND b > 2 AND __name__ > /k/123.
• START AFTER (10): avvia la query subito dopo a = 1 AND b > 10.

A differenza di OFFSET, che richiede la scansione dei primi N risultati per saltare, un cursore di avvio consente alla query di iniziare in una posizione logica. Questa posizione non è necessaria per corrispondere a un risultato effettivo, verrà eseguita la scansione in avanti da questa posizione per trovare il documento successivo.

Richiede:

• Il numero di valori non può essere maggiore del numero di campi specificati nella clausola ORDER BY.

Cursor

Un potenziale prefisso di una posizione nel set di risultati in cui terminare la query.

È simile a START_AT, ma controlla la posizione finale anziché la posizione iniziale.

Richiede:

• Il numero di valori non può essere maggiore del numero di campi specificati nella clausola ORDER BY.

int32

Il numero di documenti da saltare prima di restituire il primo risultato.

Questo si applica dopo i vincoli specificati da WHERE, START AT e END AT, ma prima della clausola LIMIT.

Richiede:

• Il valore deve essere maggiore o uguale a zero, se specificato.

Int32Value

Il numero massimo di risultati da restituire.

Si applica dopo tutti gli altri vincoli.

Richiede:

• Il valore deve essere maggiore o uguale a zero, se specificato.

FindNearest

Campo facoltativo. Una ricerca dei potenziali vicini più prossimi.

Si applica dopo tutti gli altri filtri e ordine.

Trova gli incorporamenti vettoriali più vicini al vettore di query specificato.

string

L'ID raccolta. Se impostato, vengono selezionate solo le collezioni con questo ID.

bool

Quando il valore è false, vengono selezionate solo le raccolte che sono elementi secondari immediati del valore di parent specificato nella sezione RunQueryRequest contenitore. Se il valore è true, vengono selezionate tutte le raccolte discendenti.

Operator

L'operatore per combinare più filtri.

Filter

L'elenco di filtri da combinare.

Richiede:

• È presente almeno un filtro.

FieldReference

Il campo in base al quale applicare il filtro.

Operator

L'operatore in base al quale applicare il filtro.

Value

Il valore con cui eseguire il confronto.

string

Un riferimento a un campo in un documento.

Richiede:

• DEVE essere una stringa di segmenti delimitata da punti (.), in cui ogni segmento è conforme alle limitazioni di document field name.

CompositeFilter

Un filtro composto.

FieldFilter

Un filtro su un campo documento.

UnaryFilter

Un filtro che accetta esattamente un argomento.

FieldReference

obbligatorio. Un campo del vettore indicizzato in cui eseguire la ricerca. È possibile restituire solo i documenti che contengono vettori la cui dimensionalità corrisponde a query_vector.

Value

obbligatorio. Il vettore di query su cui stiamo effettuando la ricerca. Deve essere un vettore di massimo 2048 dimensioni.

DistanceMeasure

obbligatorio. La misurazione della distanza da utilizzare, obbligatoria.

Int32Value

obbligatorio. Il numero di vicini più prossimi da restituire. Deve essere un numero intero positivo non superiore a 1000.

FieldReference

Il campo in base al quale ordinare.

Direction

La direzione in base alla quale ordinare. Il valore predefinito è ASCENDING.

FieldReference

I campi da restituire.

Se è vuoto, vengono restituiti tutti i campi. Per restituire solo il nome del documento, utilizza ['__name__'].

Operator

L'operatore unario da applicare.

FieldReference

Il campo a cui applicare l'operatore.

int32

L'ID target che identifica il target nello stream. Deve essere un numero positivo e diverso da zero.

Se target_id è 0 (o non specificato), il server assegnerà un ID per questo target e lo restituirà in un evento TargetChange::ADD. Una volta aggiunto un target con target_id=0, tutti i target successivi devono avere anche target_id=0. Se una richiesta AddTarget con target_id != 0 viene inviata al server dopo l'aggiunta di una destinazione con target_id=0, il server invia immediatamente una risposta con un evento TargetChange::Remove.

Tieni presente che se il client invia più richieste AddTarget senza un ID, l'ordine degli ID restituiti in TargetChage.target_ids non è definito. Di conseguenza, i client dovrebbero fornire un ID target invece di affidarsi al server per assegnarne uno.

Se target_id è diverso da zero, non deve esistere un target attivo per questo stream con lo stesso ID.

bool

Se il target deve essere rimosso quando è attuale e coerente.

Int32Value

Il numero di documenti che corrispondono per ultimo alla query al momento del token di ripristino o di lettura.

Questo valore è pertinente solo se viene fornito un resume_type. Questo valore è presente e indica un indicatore maggiore di zero che il client vuole che ExistenceFilter.unchanged_names venga incluso nella risposta.

QueryTarget

Un target specificato da una query.

DocumentsTarget

Un target specificato da un insieme di nomi di documenti.

bytes

Un token di ripristino di un TargetChange precedente per un target identico.

L'utilizzo di un token di ripristino con una destinazione diversa non è supportato e potrebbe non riuscire.

Timestamp

Inizia l'ascolto dopo un intervallo di tempo specifico di read_time.

Al momento il cliente deve conoscere lo stato dei documenti corrispondenti.

string

I nomi dei documenti da recuperare. Nel formato: projects/{project_id}/databases/{database_id}/documents/{document_path}. La richiesta avrà esito negativo se uno qualsiasi del documento non è una risorsa secondaria del database specificato. I nomi duplicati verranno eliminati.

string

Il nome della risorsa padre. Nel formato: projects/{project_id}/databases/{database_id}/documents o projects/{project_id}/databases/{database_id}/documents/{document_path}. Ad esempio: projects/my-project/databases/my-database/documents o projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

StructuredQuery

Una query strutturata.

TargetChangeType

Il tipo di modifica che si è verificata.

int32

Gli ID dei target che sono stati modificati.

Se vuoto, la modifica si applica a tutti i target.

L'ordine degli ID target non è definito.

Status

L'errore che ha generato questa modifica, se applicabile.

bytes

Un token che può essere utilizzato per riprendere lo streaming per il valore target_ids specificato o per tutti i target se il campo target_ids è vuoto.

Non impostato a ogni modifica del target.

Timestamp

Il valore read_time coerente per il valore target_ids specificato (omesso quando gli ID target non sono presenti in uno snapshot coerente).

È garantito che lo stream invii read_time con target_ids vuoto ogni volta che l'intero stream raggiunge un nuovo snapshot coerente. I messaggi ADD, CURRENT e RESET garantiscono (alla fine) un nuovo snapshot coerente, mentre i messaggi NO_CHANGE e REMOVE non lo saranno.

È garantito che read_time aumenterà monotonicamente per un determinato stream.

ReadOnly

La transazione può essere utilizzata solo per le operazioni di lettura.

ReadWrite

La transazione può essere utilizzata per le operazioni di lettura e scrittura.

Timestamp

Legge i documenti nel momento specificato.

Deve essere un timestamp con precisione in microsecondi risalente all'ultima ora oppure, se il recupero point-in-time è abilitato, può essere anche un timestamp di un minuto intero compreso negli ultimi 7 giorni.

bytes

Transazione facoltativa per riprovare.

Document

obbligatorio. Documento aggiornato. Crea il documento se non esiste già.

DocumentMask

I campi da aggiornare. Nessuno dei percorsi di campo nella maschera può contenere un nome riservato.

Se il documento esiste sul server e contiene campi a cui non viene fatto riferimento nella maschera, questi vengono lasciati invariati. I campi a cui viene fatto riferimento nella maschera, ma non presenti nel documento di input, vengono eliminati dal documento sul server.

DocumentMask

I campi da restituire. Se non viene configurato, restituisce tutti i campi.

Se il documento ha un campo che non è presente in questa maschera, quel campo non verrà restituito nella risposta.

Precondition

Una condizione preliminare facoltativa sul documento. La richiesta avrà esito negativo se questa impostazione viene impostata e non viene soddisfatta dal documento di destinazione.

NullValue

Un valore nullo.

bool

Un valore booleano.

int64

Un valore intero.

double

Un valore doppio.

Timestamp

Un valore di timestamp.

Precisione solo in microsecondi. Una volta archiviata, la precisione aggiuntiva viene arrotondata per difetto.

string

Un valore stringa.

La stringa, rappresentata come UTF-8, non deve superare 1 MiB-89 byte. Solo i primi 1500 byte della rappresentazione UTF-8 vengono considerati dalle query.

bytes

Un valore di byte.

Non deve superare 1 MiB - 89 byte. Solo i primi 1500 byte vengono considerati dalle query.

string

Un riferimento a un documento. Ad esempio: projects/{project_id}/databases/{database_id}/documents/{document_path}.

LatLng

Un valore punto geografico che rappresenta un punto sulla superficie della Terra.

ArrayValue

Un valore array.

Non può contenere direttamente un altro valore dell'array, anche se può contenere una mappa contenente un altro array.

MapValue

Un valore della mappa.

DocumentMask

I campi da aggiornare in questa scrittura.

Questo campo può essere impostato solo quando l'operazione è update. Se la maschera non è impostata per un update ed esiste il documento, i dati esistenti verranno sovrascritti. Se la maschera è impostata e il documento sul server ha campi non coperti dalla maschera, questi rimangono invariati. I campi a cui viene fatto riferimento nella maschera, ma non presenti nel documento di input, vengono eliminati dal documento sul server. I percorsi dei campi in questa maschera non devono contenere un nome di campo riservato.

FieldTransform

Le trasformazioni da eseguire dopo l'aggiornamento.

Questo campo può essere impostato solo quando l'operazione è update. Se presente, questa scrittura equivale a eseguire update e transform per lo stesso documento a livello atomico e in ordine.

Precondition

Una condizione preliminare facoltativa sul documento.

La scrittura avrà esito negativo se questo viene impostato e non viene soddisfatto dal documento di destinazione.

Document

Un documento da scrivere.

string

Il nome di un documento da eliminare. Nel formato: projects/{project_id}/databases/{database_id}/documents/{document_path}.

DocumentTransform

Applica una trasformazione a un documento.

string

obbligatorio. Il nome del database. Nel formato: projects/{project_id}/databases/{database_id}. Questo campo è obbligatorio solo nel primo messaggio.

string

L'ID del flusso di scrittura da riprendere. Può essere impostato solo nel primo messaggio. Se il campo viene lasciato vuoto, verrà creato un nuovo flusso di scrittura.

Write

Le operazioni di scrittura da applicare.

Esegui sempre a livello atomico e in ordine. Deve essere vuoto nella prima richiesta. Questo campo potrebbe essere vuoto nell'ultima richiesta. Questo campo non deve essere vuoto in tutte le altre richieste.

bytes

Un token stream precedentemente inviato dal server.

Il client deve impostare questo campo sul token dell'ultimo WriteResponse che ha ricevuto. Questo conferma che il client ha ricevuto risposte fino a questo token. Dopo l'invio di questo token, i token precedenti potrebbero non essere più utilizzati.

Il server potrebbe chiudere il flusso se ci sono troppe risposte non confermate.

Lascia questo campo non impostato quando crei un nuovo stream. Per riprendere uno stream in un momento specifico, imposta questo campo e il campo stream_id.

Lascia questo campo non impostato quando crei un nuovo stream.

map<string, string>

Etichette associate a questa richiesta di scrittura.

string

L'ID dello stream. Impostata solo sul primo messaggio, quando è stato creato un nuovo stream.

bytes

Un token che rappresenta la posizione di questa risposta nel flusso. Questa opzione può essere utilizzata da un client per riprendere lo streaming a questo punto.

Questo campo è sempre impostato.

WriteResult

Il risultato dell'applicazione delle scritture.

Questo risultato di scrittura i-th corrisponde alla scrittura i-esima nella richiesta.

Timestamp

L'ora in cui si è verificato il commit. Qualsiasi lettura con un valore read_time uguale o maggiore è garantito per vedere gli effetti della scrittura.

Timestamp

L'ora dell'ultimo aggiornamento del documento dopo l'applicazione della scrittura. Non impostato dopo delete.

Se la scrittura non ha effettivamente modificato il documento, si tratta del valore update_time precedente.

Value

I risultati dell'applicazione di ogni DocumentTransform.FieldTransform, nello stesso ordine.