Un riferimento a una transazione.
L'oggetto Transaction passato alla updateFunction di una transazione fornisce i metodi per leggere e scrivere dati nel contesto della transazione. Vedi runTransaction() .
Firma:
export declare class Transaction
Metodi
| Metodo | Modificatori | Descrizione |
|---|---|---|
| elimina(Rifdocumento) | Elimina il documento a cui fa riferimento il DocumentReference fornito . | |
| get(Rifdocumento) | Legge il documento a cui fa riferimento l' oggetto 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 il DocumentReference fornito . 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 . |
Transazione.delete()
Elimina il documento a cui fa riferimento il DocumentReference fornito .
Firma:
delete<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>): this;
Parametri
| Parametro | Tipo | Descrizione |
|---|---|---|
| documentoRif | Riferimento documento <AppModelType, DbModelType> | Un riferimento al documento da eliminare. |
Ritorna:
Questo
Questa istanza Transaction . Utilizzato per concatenare le chiamate ai metodi.
Transazione.get()
Legge il documento a cui fa riferimento il DocumentReference fornito .
Firma:
get<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>): Promise<DocumentSnapshot<AppModelType, DbModelType>>;
Parametri
| Parametro | Tipo | Descrizione |
|---|---|---|
| documentoRif | Riferimento documento <AppModelType, DbModelType> | Un riferimento al documento da leggere. |
Ritorna:
Promessa< DocumentSnapshot <AppModelType, DbModelType>>
Un DocumentSnapshot con i dati letti.
Transazione.set()
Scrive al documento a cui fa riferimento il DocumentReference fornito . Se il documento non esiste ancora, verrà creato.
Firma:
set<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, data: WithFieldValue<AppModelType>): this;
Parametri
| Parametro | Tipo | Descrizione |
|---|---|---|
| documentoRif | Riferimento documento <AppModelType, DbModelType> | Un riferimento al documento da impostare. |
| dati | ConFieldValue <AppModelType> | Un oggetto dei campi e dei valori per il documento. |
Ritorna:
Questo
Questa istanza Transaction . Utilizzato per concatenare le chiamate ai metodi.
Eccezioni
Errore: se l'input fornito non è un documento Firestore valido.
Transazione.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<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, data: PartialWithFieldValue<AppModelType>, options: SetOptions): this;
Parametri
| Parametro | Tipo | Descrizione |
|---|---|---|
| documentoRif | Riferimento documento <AppModelType, DbModelType> | Un riferimento al documento da impostare. |
| dati | ParzialeConFieldValue <AppModelType> | Un oggetto dei campi e dei valori per il documento. |
| opzioni | Imposta opzioni | Un oggetto per configurare il comportamento impostato. |
Ritorna:
Questo
Questa istanza Transaction . Utilizzato per concatenare le chiamate ai metodi.
Eccezioni
Errore: se l'input fornito non è un documento Firestore valido.
Transazione.aggiornamento()
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<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, data: UpdateData<DbModelType>): this;
Parametri
| Parametro | Tipo | Descrizione |
|---|---|---|
| documentoRif | Riferimento documento <AppModelType, DbModelType> | Un riferimento al documento da aggiornare. |
| dati | Aggiorna dati <TipomodelloDb> | 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:
Questo
Questa istanza Transaction . Utilizzato per concatenare le chiamate ai metodi.
Eccezioni
Errore: se l'input fornito non è un dato Firestore valido.
Transazione.aggiornamento()
Aggiorna i campi nel documento a cui fa riferimento il DocumentReference fornito . 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<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, field: string | FieldPath, value: unknown, ...moreFieldsAndValues: unknown[]): this;
Parametri
| Parametro | Tipo | Descrizione |
|---|---|---|
| documentoRif | Riferimento documento <AppModelType, DbModelType> | 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:
Questo
Questa istanza Transaction . Utilizzato per concatenare le chiamate ai metodi.
Eccezioni
Errore: se l'input fornito non è un dato Firestore valido.