Abstract Class: BaseVectorStore

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

Extended by

• TypesenseVectorStore
• WeaviateVectorStore
• VespaVectorStore
• SurrealDBVectorStore
• SqliteVecVectorStore
• SolrVectorStore
• S3VectorsVectorStore
• QdrantVectorStore
• PineconeVectorStore
• PgVectorStore
• RedisVectorStore
• OpenSearchVectorStore
• OramaVectorStore
• Neo4jVectorStore
• Oracle23aiVectorStore
• MongoDBVectorStore
• MariaDBVectorStore
• MilvusVectorStore
• MeilisearchVectorStore
• InMemoryVectorStore
• LanceDBVectorStore
• DuckDBVectorStore
• HnswlibVectorStore
• ElasticsearchVectorStore
• CloudflareVectorizeVectorStore
• ChromaVectorStore
• ClickHouseVectorStore
• ArangoDBVectorStore
• CouchbaseVectorStore

Implements

• PlanSink
• SchemaExecutor

Constructors

Constructor

new BaseVectorStore(options: BaseVectorStoreOptions): BaseVectorStore;

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

Parameters

Parameter	Type
options	BaseVectorStoreOptions

Returns

BaseVectorStore

Properties

Property	Modifier	Type	Defined in
capabilities	abstract	VectorStoreCapabilities	batteries/vector/contract.ts:32

Accessors

schema

Get Signature

get schema(): VectorSchemaBuilder;

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

Returns

VectorSchemaBuilder

Methods

asCallable()

asCallable(): CallableVectorStore;

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

Returns

CallableVectorStore

---

close()

abstract close(): Promise<void>;

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

Returns

Promise<void>

---

connect()

abstract connect(): Promise<void>;

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

Returns

Promise<void>

---

createCollection()

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

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

Parameters

Parameter	Type
spec	CollectionSpec
ifNotExists	boolean

Returns

Promise<void>

Implementation of

SchemaExecutor.createCollection

---

dropCollection()

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

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

Parameters

Parameter	Type
collection	string
ifExists	boolean

Returns

Promise<void>

Implementation of

SchemaExecutor.dropCollection

---

executeDelete()

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

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

Parameters

Parameter	Type
plan	DeletePlan

Returns

Promise<void>

Implementation of

PlanSink.executeDelete

---

executeSearch()

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

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

Parameters

Parameter	Type
plan	SearchPlan

Returns

Promise<VectorMatch[]>

Implementation of

PlanSink.executeSearch

---

executeUpsert()

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

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

Parameters

Parameter	Type
plan	UpsertPlan

Returns

Promise<void>

Implementation of

PlanSink.executeUpsert

---

hasCollection()

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

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

Parameters

Parameter	Type
collection	string

Returns

Promise<boolean>

Implementation of

SchemaExecutor.hasCollection

---

isAvailable()

abstract isAvailable(): boolean;

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

Returns

boolean

---

query()

query(collection: string): VectorQueryBuilder;

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

Parameters

Parameter	Type
collection	string

Returns

VectorQueryBuilder

---

renameCollection()

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

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

Parameters

Parameter	Type
from	string
to	string

Returns

Promise<void>

Implementation of

SchemaExecutor.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>