Oracle® Backend For Firebase JavaScript Namespace SDK Reference, Release 26.1.0
    Preparing search index...
    Oracle® Backend For Firebase JavaScript Namespace SDK Reference
    Release 26.1.0

    G48197-02

    A transaction is a set of reads and writes that are guaranteed to be atomic. Transactions are useful when you want to update a field's value based on its current value, or perform other conditional writes.

    Index

    Constructors

    Methods

    Constructors

    Methods

    • Deletes the document referred to by the provided DocumentReference.

      Parameters

      Returns Transaction

      This Transaction instance. Used for chaining method calls.

    • Writes to the document referred to by the provided DocumentReference. If the document does not exist yet, it will be created. If you pass SetOptions, the provided data can be merged into the existing document.

      Type Parameters

      • T

      Parameters

      • documentRef: DocumentReference<T>

        A reference to the document to be set.

      • data: T

        An object of the fields and values for the document.

      • Optionaloptions: { merge?: boolean; mergeFields?: (string | FieldPath)[] }

        An object to configure the set behavior.

      Returns Transaction

      This Transaction instance. Used for chaining method calls.

    • Updates fields in the document referred to by the provided DocumentReference. The update will fail if applied to a document that does not exist.

      Parameters

      • documentRef: DocumentReference<any>

        A reference to the document to be updated.

      • data: { [field: string]: any }

        An object containing the fields and values with which to update the document. Fields can contain dots to reference nested fields within the document.

      Returns Transaction

      This Transaction instance. Used for chaining method calls.

    • Updates fields in the document referred to by the provided DocumentReference. The update will fail if applied to a document that does not exist.

      Nested fields can be updated by providing dot-separated field path strings or by providing FieldPath values.

      Parameters

      • documentRef: DocumentReference<any>

        A reference to the document to be updated.

      • field: string | FieldPath

        The first field to update.

      • value: any

        The first value.

      • ...moreFieldsAndValues: any[]

        Additional key/value pairs.

      Returns Transaction

      A Promise resolved once the data has been successfully written to the backend (Note that it won't resolve while you're offline).