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

Class FieldValue

Represents a operation for a fieldvalue in a document to be applied to server.

Index

Constructors

Methods

isEqual arrayRemove arrayUnion delete deleteVector denseVector increment serverTimestamp sparseVector

Constructors

constructor

new FieldValue(): FieldValue
Returns FieldValue

Methods

isEqual

isEqual(other: FieldValue): boolean
Compares this FieldValue with another FieldValue instance.
Parameters
- other: FieldValue
  Another FieldValue instance to compare.
Returns boolean
true if both are equal, false otherwise.

Throws
Throws an error if the provided object is not an instance of FieldValue.
- Defined in oracledb/field/value.d.ts:46

`Static`arrayRemove

arrayRemove(...elements: any[]): FieldValue
Creates a FieldValue instance for remove operation in a array field.
Parameters
- ...elements: any[]
  Multiple values that needs to be removed.
Returns FieldValue
FieldValue instance representing the change.
- Defined in oracledb/field/value.d.ts:60

`Static`arrayUnion

arrayUnion(...elements: any[]): FieldValue
Creates a FieldValue instance for union operation in a array field.
Parameters
- ...elements: any[]
  Multiple values that needs to be applied in union.
Returns FieldValue
FieldValue instance representing the change.
- Defined in oracledb/field/value.d.ts:75

`Static`delete

delete(): FieldValue
Creates a FieldValue instance for delete operation of a field.

Returns FieldValue
FieldValue instance representing the change.
- Defined in oracledb/field/value.d.ts:87

`Static`deleteVector

deleteVector(): FieldValue
Creates a FieldValue instance for deleting an embedding entry in v2.

Returns FieldValue
FieldValue instance representing the change.
Example
```
await docRef.update({
  LEGACY_EMB: FieldValue.deleteVector()
});
```
- Defined in oracledb/field/value.d.ts:136

`Static`denseVector

denseVector(values: number[]): { type: "dense"; values: number[] }
Creates a dense embedding payload.
Parameters
- values: number[]
Returns { type: "dense"; values: number[] }
Example
```
await docRef.update({
  DENSE_EMB: FieldValue.denseVector([0.12, -0.91, 0.44])
});
```
Example
```
await colRef.add({
  title: "vector doc",
  DENSE_EMB: FieldValue.denseVector([0.12, -0.91, 0.44])
});
```
- Defined in oracledb/field/value.d.ts:103

`Static`increment

increment(n: number): FieldValue
Creates a FieldValue instance for increment operation in a number field.
Parameters
- n: number
Returns FieldValue
FieldValue instance representing the change.
- Defined in oracledb/field/value.d.ts:150

`Static`serverTimestamp

serverTimestamp(): FieldValue
Creates a FieldValue instance for getting a server timestamp.

Returns FieldValue
FieldValue instance representing the change.
- Defined in oracledb/field/value.d.ts:162

`Static`sparseVector

sparseVector(
    dimension: number,
    indices: number[],
    values: number[],
): {
    dimension: number;
    indices: number[];
    type: "sparse";
    values: number[];
}
Creates a sparse embedding payload.
Parameters
- dimension: number
- indices: number[]
- values: number[]
Returns { dimension: number; indices: number[]; type: "sparse"; values: number[] }
Example
```
await docRef.update({
  SPARSE_EMB: FieldValue.sparseVector(1000, [3, 40, 777], [0.5, 0.8, 0.33])
});
```
Example
```
await colRef.add({
  title: "sparse vector doc",
  SPARSE_EMB: FieldValue.sparseVector(1000, [3, 40, 777], [0.5, 0.8, 0.33])
});
```
- Defined in oracledb/field/value.d.ts:119