Class DocumentReference<T>

constructor

• new DocumentReference<T = any>(
      db: Oracledb,
      path: string,
      parent?: CollectionReference<any>,
  ): DocumentReference<T>

  Creates a new DocumentReference instance.

  Type Parameters

  • T = any

  Parameters

  • db: Oracledb

    Database instance.

  • path: string

    Path to the document.

  • Optionalparent: CollectionReference<any>

    Parent collection.

  Returns DocumentReference<T>

id

Readonlyoracledb

parent

path

collection

• collection(colPath: string): CollectionReference<T>

  Returns the CollectionReference for the collection at the specified path.

  Parameters

  • colPath: string

  Returns CollectionReference<T>

delete

• delete(): Promise<void>

  Deletes the document referred by this.

  Returns Promise<void>

get

• get(options?: { source: "server" }): Promise<DocumentSnapshot<T>>

  Reads the document for this.

  Parameters

  • Optionaloptions: { source: "server" }

  Returns Promise<DocumentSnapshot<T>>

isEqual

• isEqual(other: DocumentReference<T>): boolean

  Checks whether this DocumentReference is equal to the provided one.

  Parameters

  • other: DocumentReference<T>

  Returns boolean

  Returns true if both DocumentReference instances are the same.

  Throws

  Throws an error if docRef is not a DocumentReference instance.

onSnapshot

• onSnapshot(
      observer: {
          complete?: () => void;
          error?: (error: Error) => void;
          next?: (snapshot: DocumentSnapshot<T>) => void;
      },
  ): () => void

  Attaches callback to be executed on DocumentSnapshot events. This is related to real time listening where we are using long-polling by default.

  ( observer : { complete ?: ( ) => void ; error ?: ( error :
  OracledbError ) => void ; next ?: ( snapshot : DocumentSnapshot => void ) )

  ( onNext : ( snapshot : DocumentSnapshot < T > ) => void , onError ? : ( error : OracledbError ) => void , onCompletion ? : ( ) => void )

  Parameters

  • observer: {
        complete?: () => void;
        error?: (error: Error) => void;
        next?: (snapshot: DocumentSnapshot<T>) => void;
    }

  Returns () => void

set

• set(
      data: T,
      setOptions?: { merge: boolean; mergeFields?: string[] },
  ): Promise<void>

  Writes to the document.

  Parameters

  • data: T
  • OptionalsetOptions: { merge: boolean; mergeFields?: string[] }

  Returns Promise<void>

update

• update(data: Partial<T>): Promise<void>

  Updates fields for the document referred by this.

  Parameters

  • data: Partial<T>

  Returns Promise<void>

withConverter

• withConverter<U>(converter: any): DocumentReference<U>

  Custom data converter, allowing to use user defined classes with database instance. When get is called on the query the results are returned after applying the converter. Passing null will remove the current converter.

  Type Parameters

  • U

  Parameters

  • converter: any

    Object with two functions "fromOracledb" and "toOracledb". fromOracledb will be used to convert the json objects to user defined classes and toOracledb will be used to convert from user defined classes to json objects.

  Returns DocumentReference<U>

  DocumentReference instance with converter.