Class: SurrealDBVectorStore

Defined in: batteries/vector/surrealdb/index.ts:66

Extends

• BaseVectorStore

Constructors

Constructor

new SurrealDBVectorStore(options: BaseVectorStoreOptions): SurrealDBVectorStore;

Defined in: batteries/vector/contract.ts:35

Parameters

Parameter	Type
options	BaseVectorStoreOptions

Returns

SurrealDBVectorStore

Inherited from

BaseVectorStore.constructor

Properties

Property	Modifier	Type	Overrides	Defined in
capabilities	readonly	VectorStoreCapabilities	BaseVectorStore.capabilities	batteries/vector/surrealdb/index.ts:67

Accessors

schema

Get Signature

get schema(): VectorSchemaBuilder;

Defined in: batteries/vector/contract.ts:64

Returns

VectorSchemaBuilder

Inherited from

BaseVectorStore.schema

Methods

asCallable()

asCallable(): CallableVectorStore;

Defined in: batteries/vector/contract.ts:73

Returns

CallableVectorStore

Inherited from

BaseVectorStore.asCallable

---

close()

close(): Promise<void>;

Defined in: batteries/vector/surrealdb/index.ts:108

Returns

Promise<void>

Overrides

BaseVectorStore.close

---

connect()

connect(): Promise<void>;

Defined in: batteries/vector/surrealdb/index.ts:91

Returns

Promise<void>

Overrides

BaseVectorStore.connect

---

createCollection()

createCollection(spec: CollectionSpec, ifNotExists: boolean): Promise<void>;

Defined in: batteries/vector/surrealdb/index.ts:126

Parameters

Parameter	Type
spec	CollectionSpec
ifNotExists	boolean

Returns

Promise<void>

Overrides

BaseVectorStore.createCollection

---

dropCollection()

dropCollection(collection: string, ifExists: boolean): Promise<void>;

Defined in: batteries/vector/surrealdb/index.ts:136

Parameters

Parameter	Type
collection	string
ifExists	boolean

Returns

Promise<void>

Overrides

BaseVectorStore.dropCollection

---

executeDelete()

executeDelete(plan: DeletePlan): Promise<void>;

Defined in: batteries/vector/surrealdb/index.ts:287

Parameters

Parameter	Type
plan	DeletePlan

Returns

Promise<void>

Overrides

BaseVectorStore.executeDelete

---

executeSearch()

executeSearch(plan: SearchPlan): Promise<VectorMatch[]>;

Defined in: batteries/vector/surrealdb/index.ts:200

Parameters

Parameter	Type
plan	SearchPlan

Returns

Promise<VectorMatch[]>

Overrides

BaseVectorStore.executeSearch

---

executeUpsert()

executeUpsert(plan: UpsertPlan): Promise<void>;

Defined in: batteries/vector/surrealdb/index.ts:161

Parameters

Parameter	Type
plan	UpsertPlan

Returns

Promise<void>

Overrides

BaseVectorStore.executeUpsert

---

hasCollection()

hasCollection(collection: string): Promise<boolean>;

Defined in: batteries/vector/surrealdb/index.ts:146

Parameters

Parameter	Type
collection	string

Returns

Promise<boolean>

Overrides

BaseVectorStore.hasCollection

---

isAvailable()

isAvailable(): boolean;

Defined in: batteries/vector/surrealdb/index.ts:87

Returns

boolean

Overrides

BaseVectorStore.isAvailable

---

query()

query(collection: string): VectorQueryBuilder;

Defined in: batteries/vector/contract.ts:68

Parameters

Parameter	Type
collection	string

Returns

VectorQueryBuilder

Inherited from

BaseVectorStore.query

---

renameCollection()

renameCollection(_from: string, _to: string): Promise<void>;

Defined in: batteries/vector/surrealdb/index.ts:157

Parameters

Parameter	Type
_from	string
_to	string

Returns

Promise<void>

Overrides

BaseVectorStore.renameCollection

---

transaction()

transaction(_fn: (tx: CallableVectorStore) => Promise<void>): Promise<void>;

Defined in: batteries/vector/contract.ts:60

Parameters

Parameter	Type
_fn	(tx: CallableVectorStore) => Promise<void>

Returns

Promise<void>

Inherited from

BaseVectorStore.transaction

---

isAvailable()

static isAvailable(): boolean;

Defined in: batteries/vector/surrealdb/index.ts:84

Returns

boolean