Interface: VectorStore()

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

Extends

• PlanSink.SchemaExecutor

VectorStore(collection: string): VectorQueryBuilder;

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

Parameters

Parameter	Type
collection	string

Returns

VectorQueryBuilder

Properties

Property	Modifier	Type	Defined in
capabilities	readonly	VectorStoreCapabilities	batteries/vector/contract.ts:22
schema	public	VectorSchemaBuilder	batteries/vector/contract.ts:27

Methods

close()

close(): Promise<void>;

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

Returns

Promise<void>

---

connect()

connect(): Promise<void>;

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

Returns

Promise<void>

---

createCollection()

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

Defined in: batteries/vector/schema.ts:11

Parameters

Parameter	Type
spec	CollectionSpec
ifNotExists	boolean

Returns

Promise<void>

Inherited from

SchemaExecutor.createCollection

---

dropCollection()

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

Defined in: batteries/vector/schema.ts:12

Parameters

Parameter	Type
collection	string
ifExists	boolean

Returns

Promise<void>

Inherited from

SchemaExecutor.dropCollection

---

executeDelete()

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

Defined in: batteries/vector/builder.ts:49

Parameters

Parameter	Type
plan	DeletePlan

Returns

Promise<void>

Inherited from

PlanSink.executeDelete

---

executeSearch()

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

Defined in: batteries/vector/builder.ts:47

Parameters

Parameter	Type
plan	SearchPlan

Returns

Promise<VectorMatch[]>

Inherited from

PlanSink.executeSearch

---

executeUpsert()

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

Defined in: batteries/vector/builder.ts:48

Parameters

Parameter	Type
plan	UpsertPlan

Returns

Promise<void>

Inherited from

PlanSink.executeUpsert

---

hasCollection()

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

Defined in: batteries/vector/schema.ts:13

Parameters

Parameter	Type
collection	string

Returns

Promise<boolean>

Inherited from

SchemaExecutor.hasCollection

---

isAvailable()

isAvailable(): boolean;

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

Returns

boolean

---

renameCollection()

renameCollection(from: string, to: string): Promise<void>;

Defined in: batteries/vector/schema.ts:14

Parameters

Parameter	Type
from	string
to	string

Returns

Promise<void>

Inherited from

SchemaExecutor.renameCollection

---

transaction()

transaction(fn: (tx: VectorStore) => Promise<void>): Promise<void>;

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

Parameters

Parameter	Type
fn	(tx: VectorStore) => Promise<void>

Returns

Promise<void>