Class: ClickHouseVectorStore

Defined in: src/batteries/vector/clickhouse/index.ts:71

Abstract base shared by every bundled vector adapter. It implements the cross-cutting surface (query/schema/transaction/asCallable/encode) on top of the small set of backend-specific abstract methods each adapter fills in (connect, executeSearch, createCollection, …). Concrete adapters inherit the doc comments below unless they override them.

Extends

• BaseVectorStore

Constructors

Constructor

new ClickHouseVectorStore(options: BaseVectorStoreOptions): ClickHouseVectorStore;

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

Parameters

Parameter	Type
options	BaseVectorStoreOptions

Returns

ClickHouseVectorStore

Inherited from

BaseVectorStore.constructor

Properties

Property	Modifier	Type	Description	Overrides	Defined in
capabilities	readonly	VectorStoreCapabilities	Static description of what this backend supports — see VectorStoreCapabilities.	BaseVectorStore.capabilities	src/batteries/vector/clickhouse/index.ts:72

Accessors

schema

Get Signature

get schema(): VectorSchemaBuilder;

Defined in: src/batteries/vector/contract.ts:109

Schema builder bound to this store, for creating/dropping/migrating collections.

Returns

VectorSchemaBuilder

Inherited from

BaseVectorStore.schema

Methods

asCallable()

asCallable(): CallableVectorStore;

Defined in: src/batteries/vector/contract.ts:123

Wrap this store in a callable proxy so store('collection') is shorthand for store.query('collection'), while all other methods/properties pass through unchanged.

Returns

CallableVectorStore

Inherited from

BaseVectorStore.asCallable

---

close()

close(): Promise<void>;

Defined in: src/batteries/vector/clickhouse/index.ts:113

Release the backing connection and any held resources.

Returns

Promise<void>

Overrides

BaseVectorStore.close

---

connect()

connect(): Promise<void>;

Defined in: src/batteries/vector/clickhouse/index.ts:97

Establish the backing connection (open clients, pools, sockets). Idempotent where the driver allows.

Returns

Promise<void>

Overrides

BaseVectorStore.connect

---

createCollection()

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

Defined in: src/batteries/vector/clickhouse/index.ts:131

Create a collection from spec; a no-op when ifNotExists and it already exists.

Parameters

Parameter	Type
spec	CollectionSpec
ifNotExists	boolean

Returns

Promise<void>

Overrides

BaseVectorStore.createCollection

---

dropCollection()

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

Defined in: src/batteries/vector/clickhouse/index.ts:147

Drop a collection; a no-op when ifExists and it is absent.

Parameters

Parameter	Type
collection	string
ifExists	boolean

Returns

Promise<void>

Overrides

BaseVectorStore.dropCollection

---

executeDelete()

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

Defined in: src/batteries/vector/clickhouse/index.ts:302

Execute a compiled delete plan.

Parameters

Parameter	Type
plan	DeletePlan

Returns

Promise<void>

Overrides

BaseVectorStore.executeDelete

---

executeSearch()

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

Defined in: src/batteries/vector/clickhouse/index.ts:227

Execute a compiled search plan and return the matched records.

Parameters

Parameter	Type
plan	SearchPlan

Returns

Promise<VectorMatch[]>

Overrides

BaseVectorStore.executeSearch

---

executeUpsert()

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

Defined in: src/batteries/vector/clickhouse/index.ts:177

Execute a compiled upsert plan (insert-or-replace the given records).

Parameters

Parameter	Type
plan	UpsertPlan

Returns

Promise<void>

Overrides

BaseVectorStore.executeUpsert

---

hasCollection()

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

Defined in: src/batteries/vector/clickhouse/index.ts:158

Whether a collection currently exists in the backend.

Parameters

Parameter	Type
collection	string

Returns

Promise<boolean>

Overrides

BaseVectorStore.hasCollection

---

isAvailable()

isAvailable(): boolean;

Defined in: src/batteries/vector/clickhouse/index.ts:93

Whether the backend's optional peer dependency is installed and the store is usable.

Returns

boolean

Overrides

BaseVectorStore.isAvailable

---

query()

query(collection: string): VectorQueryBuilder;

Defined in: src/batteries/vector/contract.ts:114

Open a VectorQueryBuilder scoped to collection (default top-K of 10).

Parameters

Parameter	Type
collection	string

Returns

VectorQueryBuilder

Inherited from

BaseVectorStore.query

---

renameCollection()

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

Defined in: src/batteries/vector/clickhouse/index.ts:163

Rename a collection from from to to.

Parameters

Parameter	Type
from	string
to	string

Returns

Promise<void>

Overrides

BaseVectorStore.renameCollection

---

transaction()

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

Defined in: src/batteries/vector/contract.ts:104

Run fn inside a backend transaction. The base implementation rejects with E_VECTOR_STORE_TRANSACTIONS_UNSUPPORTED; adapters whose backend supports transactions override this.

Parameters

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

Returns

Promise<void>

Inherited from

BaseVectorStore.transaction

---

isAvailable()

static isAvailable(): boolean;

Defined in: src/batteries/vector/clickhouse/index.ts:90

Static availability probe: whether this adapter's runtime driver can load in the current environment.

Returns

boolean