Class: PgVectorStore

Defined in: batteries/vector/pgvector/index.ts:155

Extends

• BaseVectorStore

Constructors

Constructor

new PgVectorStore(options: PgVectorOptions): PgVectorStore;

Defined in: batteries/vector/pgvector/index.ts:170

Parameters

Parameter	Type
options	PgVectorOptions

Returns

PgVectorStore

Overrides

BaseVectorStore.constructor

Properties

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

Accessors

clientOrPool

Get Signature

get clientOrPool(): any;

Defined in: batteries/vector/pgvector/index.ts:243

Returns

any

---

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/pgvector/index.ts:229

Returns

Promise<void>

Overrides

BaseVectorStore.close

---

connect()

connect(): Promise<void>;

Defined in: batteries/vector/pgvector/index.ts:185

Returns

Promise<void>

Overrides

BaseVectorStore.connect

---

createCollection()

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

Defined in: batteries/vector/pgvector/index.ts:257

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/pgvector/index.ts:289

Parameters

Parameter	Type
collection	string
ifExists	boolean

Returns

Promise<void>

Overrides

BaseVectorStore.dropCollection

---

ensureConnected()

ensureConnected(): Promise<void>;

Defined in: batteries/vector/pgvector/index.ts:253

Returns

Promise<void>

---

executeDelete()

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

Defined in: batteries/vector/pgvector/index.ts:529

Parameters

Parameter	Type
plan	DeletePlan

Returns

Promise<void>

Overrides

BaseVectorStore.executeDelete

---

executeSearch()

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

Defined in: batteries/vector/pgvector/index.ts:399

Parameters

Parameter	Type
plan	SearchPlan

Returns

Promise<VectorMatch[]>

Overrides

BaseVectorStore.executeSearch

---

executeUpsert()

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

Defined in: batteries/vector/pgvector/index.ts:340

Parameters

Parameter	Type
plan	UpsertPlan

Returns

Promise<void>

Overrides

BaseVectorStore.executeUpsert

---

hasCollection()

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

Defined in: batteries/vector/pgvector/index.ts:309

Parameters

Parameter	Type
collection	string

Returns

Promise<boolean>

Overrides

BaseVectorStore.hasCollection

---

isAvailable()

isAvailable(): boolean;

Defined in: batteries/vector/pgvector/index.ts:181

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/pgvector/index.ts:320

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/pgvector/index.ts:551

Parameters

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

Returns

Promise<void>

Overrides

BaseVectorStore.transaction

---

isAvailable()

static isAvailable(): boolean;

Defined in: batteries/vector/pgvector/index.ts:178

Returns

boolean