Class DualityViewDocReference<T>

constructor

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

  Creates a new DualityViewDocReference instance.

  Type Parameters

  • T = any

  Parameters

  • db: Oracledb

    Database instance.

  • path: string

    Path to the document.

  • Optionalparent: DualityViewColReference<T>

    Parent collection.

  Returns DualityViewDocReference<T>

Readonlyid

Readonlyoracledb

Readonlyparent

Readonlypath

Readonlytype

delete

• delete(trans_obj?: any): Promise<void>

  Deletes the document referred by this.

  Parameters

  • Optionaltrans_obj: any

    Transaction object.

  Returns Promise<void>

get

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

  Reads the document for this reference.

  Parameters

  • Optionaloptions: { source: "server" }

    Options for the get operation.

  • Optionaltrans_obj: any

    Transaction object.

  Returns Promise<DocumentSnapshot<T>>

isEqual

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

  Checks if this reference is equal to another.

  Parameters

  • other: DualityViewDocReference<T>

    The other reference.

  Returns boolean

set

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

  Writes to the document.

  Parameters

  • data: T

    The data to set.

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

    Options for set.

  • Optionaltrans_obj: any

    Transaction object.

  Returns Promise<void>

update

• update(
      data: Partial<T> | { [key: string]: any },
      trans_obj?: any,
  ): Promise<void>

  Updates fields for the document referred by this.

  Parameters

  • data: Partial<T> | { [key: string]: any }

    The data to update.

  • Optionaltrans_obj: any

    Transaction object.

  Returns Promise<void>

• update(
      field: string | FieldPath,
      value: any,
      ...moreFieldsAndValues: any[],
  ): Promise<void>

  Updates specific fields for the document.

  Parameters

  • field: string | FieldPath

    The field to update.

  • value: any

    The value.

  • ...moreFieldsAndValues: any[]

    More fields and values.

  Returns Promise<void>

withConverter

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

  Applies a custom data converter to this reference.

  Type Parameters

  • U

  Parameters

  • converter: any

    The converter.

  Returns DualityViewDocReference<U>