Class DataAPIVector

Represents a vector column for Data API tables.

See DataAPIVectorLike for the types that can be converted into a DataAPIVector.

You may use the vector function as a shorthand for creating a new DataAPIVector.

See the official DataStax documentation for more information.

Implements

CollCodec<typeof DataAPIVector>
TableCodec<typeof DataAPIVector>

Index

Constructors

constructor

new DataAPIVector(vector, validate?): DataAPIVector
Creates a new DataAPIVector instance from a vector-like value.

You can set validate to false to bypass any validation if you're confident the value is a valid vector.
Parameters
- vector: DataAPIVectorLike
  The vector-like value to convert to a DataAPIVector
- validate: boolean = true
  Whether to validate the vector-like value (default: true)
Returns DataAPIVector
Throws
TypeError If vector is not a valid vector-like value
- Defined in src/documents/datatypes/vector.ts:92

Properties

`Private` `Readonly` #vector

#vector: number[] | {
$binary: string;
} | Float32Array

Type declaration

$binary: string

Accessors

length

get length(): number
Returns the length of the vector (# of floats), agnostic of the underlying type.

Returns number
The length of the vector
- Defined in src/documents/datatypes/vector.ts:114

Methods

[$SerializeForCollection]

[$SerializeForCollection](ctx): readonly [0, undefined | number[] | {
$binary: string;
}]
Implementation of $SerializeForCollection for TableCodec
Parameters
- ctx: CollSerCtx
Returns readonly [0, undefined | number[] | {
$binary: string;
}]
- Defined in src/documents/datatypes/vector.ts:64

[$SerializeForTable]

[$SerializeForTable](ctx): readonly [0, undefined | number[] | {
$binary: string;
}]
Implementation of $SerializeForTable for TableCodec
Parameters
- ctx: TableSerCtx
Returns readonly [0, undefined | number[] | {
$binary: string;
}]
- Defined in src/documents/datatypes/vector.ts:57

asArray

asArray(): number[]
Returns the vector as a number[], converting between types if necessary.

Returns number[]
The vector as a number[]
- Defined in src/documents/datatypes/vector.ts:135

asBase64

asBase64(): string
Returns the vector as a base64 string, converting between types if necessary.

Returns string
The vector as a base64 string
- Defined in src/documents/datatypes/vector.ts:181

asFloat32Array

asFloat32Array(): Float32Array
Returns the vector as a Float32Array, converting between types if necessary.

Returns Float32Array
The vector as a Float32Array
- Defined in src/documents/datatypes/vector.ts:158

raw

raw(): number[] | {
$binary: string;
} | Float32Array
Gets the raw underlying implementation of the vector.

Returns number[] | {
$binary: string;
} | Float32Array
The raw vector
- Defined in src/documents/datatypes/vector.ts:126

toString

toString(): string
Returns a pretty string representation of the DataAPIVector.

Returns string
- Defined in src/documents/datatypes/vector.ts:198

`Static` [$DeserializeForCollection]

[$DeserializeForCollection](_, value, ctx): readonly [0, undefined | DataAPIVector]
Implementation of $DeserializeForCollection for TableCodec
Parameters
- _: string
- value: any
- ctx: CollDesCtx
Returns readonly [0, undefined | DataAPIVector]
- Defined in src/documents/datatypes/vector.ts:78

`Static` [$DeserializeForTable]

[$DeserializeForTable](value, ctx): readonly [0, undefined | DataAPIVector]
Implementation of $DeserializeForTable for TableCodec
Parameters
- value: any
- ctx: TableDesCtx
Returns readonly [0, undefined | DataAPIVector]
- Defined in src/documents/datatypes/vector.ts:71

`Static` isVectorLike

isVectorLike(value): value is DataAPIVectorLike
Determines whether the given value is a vector-like value (i.e. it's DataAPIVectorLike.
Parameters
- value: unknown
  The value to check
Returns value is DataAPIVectorLike
true if the value is a vector-like value; false otherwise
- Defined in src/documents/datatypes/vector.ts:215

Class DataAPIVector

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns DataAPIVector

Throws

Properties

Private Readonly #vector

Type declaration

$binary: string

Accessors

length

Returns number

Methods

[$SerializeForCollection]

Parameters

Returns readonly [0, undefined | number[] | { $binary: string; }]

[$SerializeForTable]

Parameters

Returns readonly [0, undefined | number[] | { $binary: string; }]

asArray

Returns number[]

asBase64

Returns string

asFloat32Array

Returns Float32Array

raw

Returns number[] | { $binary: string; } | Float32Array

toString

Returns string

Static [$DeserializeForCollection]

Parameters

Returns readonly [0, undefined | DataAPIVector]

Static [$DeserializeForTable]

Parameters

Returns readonly [0, undefined | DataAPIVector]

Static isVectorLike

Parameters

Returns value is DataAPIVectorLike

Settings

Member Visibility

Theme

On This Page

`Private` `Readonly` #vector

Returns readonly [0, undefined | number[] | {
$binary: string;
}]

Returns readonly [0, undefined | number[] | {
$binary: string;
}]

Returns number[] | {
$binary: string;
} | Float32Array

`Static` [$DeserializeForCollection]

`Static` [$DeserializeForTable]

`Static` isVectorLike