Oracle® Backend For Firebase JavaScript Namespace SDK Reference
Release 26.1.0
G48197-02

Class DualityViewColReference<T>

DualityViewColReference - Represents a reference to a duality view collection.

Type Parameters

T = any

Hierarchy (View Summary)

Query<T>
- DualityViewColReference

Index

Constructors

constructor

new DualityViewColReference<T = any>(
db: Oracledb,
name: string,
): DualityViewColReference<T>
Creates a new DualityViewColReference instance.
Type Parameters
- T = any
Parameters
- db: Oracledb
  Database instance.
- name: string
  Name of the duality view.
Returns DualityViewColReference<T>
Overrides Query.constructor
- Defined in oracledb/dualityview/reference.d.ts:42

Properties

`Readonly`id

id: string

`Readonly`oracledb

oracledb: Oracledb

`Readonly`parent

parent: null

`Readonly`path

path: string

The path of the collection.

`Readonly`type

type: "dualityviewcollection"

Methods

add

add(data: T): Promise<DualityViewDocReference<T>>
Adds a new document to this collection.
Parameters
- data: T
  The document data.
Returns Promise<DualityViewDocReference<T>>
- Defined in oracledb/dualityview/reference.d.ts:66

aggregate

aggregate(obj: { [key: string]: any }): AggregateQuery
Creates a AggregateQuery with aggregate operation of type sum or average.
Parameters
- obj: { [key: string]: any }
  Object containing aggregate operations { totalPopulation: oracledb.AggregateField.sum('population') }
Returns AggregateQuery
Returns a AggregateQuery instance.

Throws
Throws an error if aggregate is used on a namedQuery.
Inherited from Query.aggregate
- Defined in oracledb/collection/query.d.ts:231

column

column(arr: string[]): Query<T>
Applies column selection to the query.
Parameters
- arr: string[]
  Array of column names.
Returns Query<T>
Returns a Query instance.
Inherited from Query.column
- Defined in oracledb/collection/query.d.ts:209

count

count(): AggregateQuery
Creates a AggregateQuery with aggregate operation as count.

Returns AggregateQuery
Returns a AggregateQuery instance.

Throws
Throws an error if count is used on a namedQuery.
Inherited from Query.count
- Defined in oracledb/collection/query.d.ts:219

doc

doc(docPath: string): DualityViewDocReference<T>
Returns the DualityViewDocReference for the document in the collection for the path.
Parameters
- docPath: string
  The document path.
Returns DualityViewDocReference<T>
- Defined in oracledb/dualityview/reference.d.ts:59

endAt

endAt(...args: any[]): Query<T>
Creates and returns a new query that along with a where clause filters documents to end at the provided document (inclusive) or fieldvalue.
Parameters
- ...args: any[]
Returns Query<T>
Returns a Query instance.

Throws
Throws an error if endAt is used on a namedQuery.
Inherited from Query.endAt
- Defined in oracledb/collection/query.d.ts:136

endBefore

endBefore(...args: any[]): Query<T>
Creates and returns a new query that along with a where clause filters documents to end before the provided document (exclusive) or fieldvalue.
Parameters
- ...args: any[]
Returns Query<T>
Returns a Query instance.

Throws
Throws an error if endBefore is used on a namedQuery.
Inherited from Query.endBefore
- Defined in oracledb/collection/query.d.ts:158

findNearest

findNearest(
    field: string,
    query:
        | { sparse?: never; vector: number[] }
        | {
            sparse: {
                dimension: number;
                indices: number[];
                type: "sparse";
                values: number[];
            };
            vector?: never;
        },
    options?: {
        metric?: "COSINE" | "EUCLIDEAN" | "DOT";
        threshold?: number;
        topK?: number;
    },
): Query<T>
Creates a vector similarity query for v2 queries.
Parameters
- field: string
- query:
      | { sparse?: never; vector: number[] }
      | {
          sparse: {
              dimension: number;
              indices: number[];
              type: "sparse";
              values: number[];
          };
          vector?: never;
      }
- Optionaloptions: { metric?: "COSINE" | "EUCLIDEAN" | "DOT"; threshold?: number; topK?: number }
Returns Query<T>
Example
```
const q = colRef.findNearest(
  "EMB",
  { vector: [0.22, 0.93, -0.1] },
  { metric: "COSINE", topK: 10 }
);
const snap = await q.get();
```
Example
```
const qSparse = colRef.findNearest(
  "EMB",
  { sparse: { type: "sparse", dimension: 1000, indices: [2, 7, 900], values: [0.9, 0.3, 0.5] } },
  { metric: "DOT", topK: 5 }
);
const sparseSnap = await qSparse.get();
```
Inherited from Query.findNearest
- Defined in oracledb/collection/query.d.ts:95

get

get(): Promise<QuerySnapshot<T>>
Executes the query and returns the result.

Returns Promise<QuerySnapshot<T>>
Overrides Query.get
- Defined in oracledb/dualityview/reference.d.ts:72

isEqual

isEqual(other: DualityViewColReference<T>): boolean
Checks if this reference is equal to another.
Parameters
- other: DualityViewColReference<T>
  The other reference.
Returns boolean
Overrides Query.isEqual
- Defined in oracledb/dualityview/reference.d.ts:79

limit

limit(limitValue: number): Query<T>
Creates and returns a new query that applies a limit clause to the query. It returns the documents with a constraint on the number of documents to be returned.
Parameters
- limitValue: number
  The maximum number of items to return.
Returns Query<T>
Returns a Query instance.

Throws
Throws an error if limit is used on a namedQuery.
Inherited from Query.limit
- Defined in oracledb/collection/query.d.ts:201

limitToLast

limitToLast(limitValue: number): Query<T>
Creates and returns a new query that applies a limit clause to the query. It returns the documents with a constraint on the number of documents to be returned. It returns the last matching documents.
Parameters
- limitValue: number
  The maximum number of items to return.
Returns Query<T>
Returns a Query instance.

Throws
Throws an error if limitToLast is used on a namedQuery.
Inherited from Query.limitToLast
- Defined in oracledb/collection/query.d.ts:169

onSnapshot

onSnapshot(
    observer: {
        complete?: () => void;
        error?: (error: Error) => void;
        next?: (snapshot: QuerySnapshot<T>) => void;
    },
): () => void
Attaches callback to be executed on QuerySnapshot 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 : QuerySnapshot => void ) )

( onNext : ( snapshot : QuerySnapshot < T > ) => void , onError ? : ( error : OracledbError ) => void , onCompletion ? : ( ) => void )
Parameters
- observer: {
      complete?: () => void;
      error?: (error: Error) => void;
      next?: (snapshot: QuerySnapshot<T>) => void;
  }
Returns () => void
Inherited from Query.onSnapshot
- Defined in oracledb/collection/query.d.ts:252

orderBy

orderBy(fieldName: string | FieldPath, dirStr?: "desc" | "asc"): Query<T>
Creates and returns a Query that when executed returns documents sorted by the given field. If not specified, it sorts the values in ascending order.
Parameters
- fieldName: string | FieldPath
  Field name to apply order by on.
- OptionaldirStr: "desc" | "asc"
  Direction or order by "asc" or "desc".
Returns Query<T>
- New Query instance.
Throws
Throws an error if orderBy is used on a namedQuery.
Inherited from Query.orderBy
- Defined in oracledb/collection/query.d.ts:181

startAfter

startAfter(...args: any[]): Query<T>
Creates and returns a new query that along with a where clause filters documents to start after the provided document (exclusive) or fieldvalue.
Parameters
- ...args: any[]
Returns Query<T>
Returns a Query instance.

Throws
Throws an error if startAfter is used on a namedQuery.
Inherited from Query.startAfter
- Defined in oracledb/collection/query.d.ts:147

startAt

startAt(...args: any[]): Query<T>
Creates and returns a new query that along with a where clause filters documents to start from the provided document (inclusive) or fieldvalue.
Parameters
- ...args: any[]
Returns Query<T>
Returns a Query instance.

Throws
Throws an error if startAt is used on a namedQuery.
Inherited from Query.startAt
- Defined in oracledb/collection/query.d.ts:125

where

where(field: string | FieldPath, opStr: string, fieldValue: any): Query<T>
Creates and returns a new query with the additional conditions to filter data. It applies a where clause to the query.
Parameters
- field: string | FieldPath
  Field name.
- opStr: string
  Operator to be used with where. "==", ">=", "<=", "<", ">", "in", "not-in", "like", "!=" (supported operators)
- fieldValue: any
  Value to be used while applying operator.
Returns Query<T>
Returns a Query instance.

Throws
Throws an error if where is used on a namedQuery.
Inherited from Query.where
- Defined in oracledb/collection/query.d.ts:114

withConverter

withConverter<U>(converter: any): Query<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 Query<U>
Query instance with converter.
Inherited from Query.withConverter
- Defined in oracledb/collection/query.d.ts:61

withVectorSearch

withVectorSearch(vectorSearch: any): Query<T>
Parameters
- vectorSearch: any
Returns Query<T>
Inherited from Query.withVectorSearch
- Defined in oracledb/collection/query.d.ts:74

Class DualityViewColReference<T>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns DualityViewColReference<T>

Properties

Readonlyid

Readonlyoracledb

Readonlyparent

Readonlypath

Readonlytype

Methods

add

Parameters

Returns Promise<DualityViewDocReference<T>>

aggregate

Parameters

Returns AggregateQuery

Throws

column

Parameters

Returns Query<T>

count

Returns AggregateQuery

Throws

doc

Parameters

Returns DualityViewDocReference<T>

endAt

Parameters

Returns Query<T>

Throws

endBefore

Parameters

Returns Query<T>

Throws

findNearest

Parameters

Returns Query<T>

Example

Example

get

Returns Promise<QuerySnapshot<T>>

isEqual

Parameters

Returns boolean

limit

Parameters

Returns Query<T>

Throws

limitToLast

Parameters

Returns Query<T>

Throws

onSnapshot

Parameters

Returns () => void

orderBy

Parameters

Returns Query<T>

Throws

startAfter

Parameters

Returns Query<T>

Throws

startAt

Parameters

Returns Query<T>

Throws

where

Parameters

Returns Query<T>

Throws

`Readonly`id

`Readonly`oracledb

`Readonly`parent

`Readonly`path

`Readonly`type