Un batch di scrittura, utilizzato per eseguire più scritture come una singola unità atomica.
Un oggetto WriteBatch può essere acquisito chiamando writeBatch() . Fornisce metodi per aggiungere scritture al batch di scrittura. Nessuna delle scritture verrà sottoposta a commit (o visibile localmente) finché non verrà chiamato WriteBatch.commit() .
Firma:
export declare class WriteBatch
Metodi
| Metodo | Modificatori | Descrizione |
|---|---|---|
| commettere() | Esegue il commit di tutte le scritture in questo batch di scrittura come una singola unità atomica. Il risultato di queste scritture si rifletterà solo nelle letture dei documenti che si verificano dopo la risoluzione della promessa restituita. Se il client è offline, la scrittura fallisce. Se desideri visualizzare le modifiche locali o le scritture nel buffer finché il client non è online, utilizza l'SDK completo di Firestore. | |
| elimina(Rifdocumento) | Elimina il documento a cui fa riferimento il DocumentReference fornito . | |
| set(Rifdocumento, dati) | Scrive al documento a cui fa riferimento il DocumentReference fornito . Se il documento non esiste ancora, verrà creato. | |
| set(Rifdocumento, dati, opzioni) | Scrive al documento a cui fa riferimento il DocumentReference fornito . Se il documento non esiste ancora, verrà creato. Se fornisci merge o mergeFields , i dati forniti possono essere uniti in un documento esistente. | |
| aggiornamento(Rifdocumento, dati) | Aggiorna i campi nel documento a cui fa riferimento il DocumentReference fornito . L'aggiornamento fallirà se applicato a un documento che non esiste. | |
| aggiornamento(documentRef, campo, valore, moreFieldsAndValues) | Aggiorna i campi nel documento a cui fa riferimento questo DocumentReference . L'aggiornamento fallirà se applicato a un documento che non esiste. I campi nidificati possono essere aggiornati fornendo stringhe di percorsi di campo separati da punti o fornendo oggetti FieldPath . |
WriteBatch.commit()
Esegue il commit di tutte le scritture in questo batch di scrittura come una singola unità atomica.
Il risultato di queste scritture si rifletterà solo nelle letture dei documenti che si verificano dopo la risoluzione della promessa restituita. Se il client è offline, la scrittura fallisce. Se desideri visualizzare le modifiche locali o le scritture nel buffer finché il client non è online, utilizza l'SDK completo di Firestore.
Firma:
commit(): Promise;
Ritorna:
Promesso
Una Promise risolta una volta che tutte le scritture nel batch sono state scritte con successo sul backend come unità atomica (nota che non si risolverà mentre sei offline).
WriteBatch.delete()
Elimina il documento a cui fa riferimento il DocumentReference fornito .
Firma:
delete(documentRef: DocumentReference): WriteBatch;
Parametri
| Parametro | Tipo | Descrizione |
|---|---|---|
| documentoRif | Riferimento documento | Un riferimento al documento da eliminare. |
Ritorna:
Questa istanza WriteBatch . Utilizzato per concatenare le chiamate ai metodi.
WriteBatch.set()
Scrive al documento a cui fa riferimento il DocumentReference fornito . Se il documento non esiste ancora, verrà creato.
Firma:
set(documentRef: DocumentReference, data: WithFieldValue): WriteBatch;
Parametri
| Parametro | Tipo | Descrizione |
|---|---|---|
| documentoRif | Riferimento documento | Un riferimento al documento da impostare. |
| dati | ConFieldValue | Un oggetto dei campi e dei valori per il documento. |
Ritorna:
Questa istanza WriteBatch . Utilizzato per concatenare le chiamate ai metodi.
WriteBatch.set()
Scrive al documento a cui fa riferimento il DocumentReference fornito . Se il documento non esiste ancora, verrà creato. Se fornisci merge o mergeFields , i dati forniti possono essere uniti in un documento esistente.
Firma:
set(documentRef: DocumentReference, data: PartialWithFieldValue, options: SetOptions): WriteBatch;
Parametri
| Parametro | Tipo | Descrizione |
|---|---|---|
| documentoRif | Riferimento documento | Un riferimento al documento da impostare. |
| dati | ParzialeConFieldValue | Un oggetto dei campi e dei valori per il documento. |
| opzioni | Imposta opzioni | Un oggetto per configurare il comportamento impostato. |
Ritorna:
Questa istanza WriteBatch . Utilizzato per concatenare le chiamate ai metodi.
Eccezioni
Errore: se l'input fornito non è un documento Firestore valido.
WriteBatch.update()
Aggiorna i campi nel documento a cui fa riferimento il DocumentReference fornito . L'aggiornamento fallirà se applicato a un documento che non esiste.
Firma:
update(documentRef: DocumentReference, data: UpdateData): WriteBatch;
Parametri
| Parametro | Tipo | Descrizione |
|---|---|---|
| documentoRif | Riferimento documento | Un riferimento al documento da aggiornare. |
| dati | Aggiorna dati | Un oggetto contenente i campi e i valori con cui aggiornare il documento. I campi possono contenere punti per fare riferimento a campi nidificati all'interno del documento. |
Ritorna:
Questa istanza WriteBatch . Utilizzato per concatenare le chiamate ai metodi.
Eccezioni
Errore: se l'input fornito non è un dato Firestore valido.
WriteBatch.update()
Aggiorna i campi nel documento a cui fa riferimento questo DocumentReference . L'aggiornamento fallirà se applicato a un documento che non esiste.
I campi nidificati possono essere aggiornati fornendo stringhe di percorsi di campo separati da punti o fornendo oggetti FieldPath .
Firma:
update(documentRef: DocumentReference, field: string | FieldPath, value: unknown, ...moreFieldsAndValues: unknown[]): WriteBatch;
Parametri
| Parametro | Tipo | Descrizione |
|---|---|---|
| documentoRif | Riferimento documento | Un riferimento al documento da aggiornare. |
| campo | stringa | CampoPercorso | Il primo campo da aggiornare. |
| valore | sconosciuto | Il primo valore. |
| moreFieldsAndValues | sconosciuto[] | Coppie chiave-valore aggiuntive. |
Ritorna:
Questa istanza WriteBatch . Utilizzato per concatenare le chiamate ai metodi.
Eccezioni
Errore: se l'input fornito non è un dato Firestore valido.