---
url: >-
  https://adk.nht.io/api/@nhtio/adk/batteries/vector/pgvector/classes/PgVectorStore.md
---

# Class: PgVectorStore

Defined in: [batteries/vector/pgvector/index.ts:155](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/pgvector/index.ts#L155)

## Extends

* [`BaseVectorStore`](../../contract/classes/BaseVectorStore.md)

## Constructors

### Constructor

```ts
new PgVectorStore(options: PgVectorOptions): PgVectorStore;
```

Defined in: [batteries/vector/pgvector/index.ts:170](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/pgvector/index.ts#L170)

#### Parameters

| Parameter | Type              |
| --------- | ----------------- |
| `options` | `PgVectorOptions` |

#### Returns

`PgVectorStore`

#### Overrides

[`BaseVectorStore`](../../contract/classes/BaseVectorStore.md).[`constructor`](../../contract/classes/BaseVectorStore.md#constructor)

## Properties

| Property                                          | Modifier   | Type                                                                           | Overrides                                                                                                                                        | Defined in                                                                                                                            |
| ------------------------------------------------- | ---------- | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------- |
|  `capabilities` | `readonly` | [`VectorStoreCapabilities`](../../types/interfaces/VectorStoreCapabilities.md) | [`BaseVectorStore`](../../contract/classes/BaseVectorStore.md).[`capabilities`](../../contract/classes/BaseVectorStore.md#property-capabilities) | [batteries/vector/pgvector/index.ts:156](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/pgvector/index.ts#L156) |

## Accessors

### clientOrPool

#### Get Signature

```ts
get clientOrPool(): any;
```

Defined in: [batteries/vector/pgvector/index.ts:243](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/pgvector/index.ts#L243)

##### Returns

`any`

***

### schema

#### Get Signature

```ts
get schema(): VectorSchemaBuilder;
```

Defined in: [batteries/vector/contract.ts:64](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/contract.ts#L64)

##### Returns

[`VectorSchemaBuilder`](../../schema/classes/VectorSchemaBuilder.md)

#### Inherited from

[`BaseVectorStore`](../../contract/classes/BaseVectorStore.md).[`schema`](../../contract/classes/BaseVectorStore.md#schema)

## Methods

### asCallable()

```ts
asCallable(): CallableVectorStore;
```

Defined in: [batteries/vector/contract.ts:73](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/contract.ts#L73)

#### Returns

[`CallableVectorStore`](../../contract/type-aliases/CallableVectorStore.md)

#### Inherited from

[`BaseVectorStore`](../../contract/classes/BaseVectorStore.md).[`asCallable`](../../contract/classes/BaseVectorStore.md#ascallable)

***

### close()

```ts
close(): Promise<void>;
```

Defined in: [batteries/vector/pgvector/index.ts:229](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/pgvector/index.ts#L229)

#### Returns

`Promise`<`void`>

#### Overrides

[`BaseVectorStore`](../../contract/classes/BaseVectorStore.md).[`close`](../../contract/classes/BaseVectorStore.md#close)

***

### connect()

```ts
connect(): Promise<void>;
```

Defined in: [batteries/vector/pgvector/index.ts:185](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/pgvector/index.ts#L185)

#### Returns

`Promise`<`void`>

#### Overrides

[`BaseVectorStore`](../../contract/classes/BaseVectorStore.md).[`connect`](../../contract/classes/BaseVectorStore.md#connect)

***

### createCollection()

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

Defined in: [batteries/vector/pgvector/index.ts:257](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/pgvector/index.ts#L257)

#### Parameters

| Parameter     | Type                                                        |
| ------------- | ----------------------------------------------------------- |
| `spec`        | [`CollectionSpec`](../../plan/interfaces/CollectionSpec.md) |
| `ifNotExists` | `boolean`                                                   |

#### Returns

`Promise`<`void`>

#### Overrides

[`BaseVectorStore`](../../contract/classes/BaseVectorStore.md).[`createCollection`](../../contract/classes/BaseVectorStore.md#createcollection)

***

### dropCollection()

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

Defined in: [batteries/vector/pgvector/index.ts:289](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/pgvector/index.ts#L289)

#### Parameters

| Parameter    | Type      |
| ------------ | --------- |
| `collection` | `string`  |
| `ifExists`   | `boolean` |

#### Returns

`Promise`<`void`>

#### Overrides

[`BaseVectorStore`](../../contract/classes/BaseVectorStore.md).[`dropCollection`](../../contract/classes/BaseVectorStore.md#dropcollection)

***

### ensureConnected()

```ts
ensureConnected(): Promise<void>;
```

Defined in: [batteries/vector/pgvector/index.ts:253](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/pgvector/index.ts#L253)

#### Returns

`Promise`<`void`>

***

### executeDelete()

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

Defined in: [batteries/vector/pgvector/index.ts:529](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/pgvector/index.ts#L529)

#### Parameters

| Parameter | Type                                                |
| --------- | --------------------------------------------------- |
| `plan`    | [`DeletePlan`](../../plan/interfaces/DeletePlan.md) |

#### Returns

`Promise`<`void`>

#### Overrides

[`BaseVectorStore`](../../contract/classes/BaseVectorStore.md).[`executeDelete`](../../contract/classes/BaseVectorStore.md#executedelete)

***

### executeSearch()

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

Defined in: [batteries/vector/pgvector/index.ts:399](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/pgvector/index.ts#L399)

#### Parameters

| Parameter | Type                                                |
| --------- | --------------------------------------------------- |
| `plan`    | [`SearchPlan`](../../plan/interfaces/SearchPlan.md) |

#### Returns

`Promise`<[`VectorMatch`](../../types/interfaces/VectorMatch.md)\[]>

#### Overrides

[`BaseVectorStore`](../../contract/classes/BaseVectorStore.md).[`executeSearch`](../../contract/classes/BaseVectorStore.md#executesearch)

***

### executeUpsert()

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

Defined in: [batteries/vector/pgvector/index.ts:340](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/pgvector/index.ts#L340)

#### Parameters

| Parameter | Type                                                |
| --------- | --------------------------------------------------- |
| `plan`    | [`UpsertPlan`](../../plan/interfaces/UpsertPlan.md) |

#### Returns

`Promise`<`void`>

#### Overrides

[`BaseVectorStore`](../../contract/classes/BaseVectorStore.md).[`executeUpsert`](../../contract/classes/BaseVectorStore.md#executeupsert)

***

### hasCollection()

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

Defined in: [batteries/vector/pgvector/index.ts:309](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/pgvector/index.ts#L309)

#### Parameters

| Parameter    | Type     |
| ------------ | -------- |
| `collection` | `string` |

#### Returns

`Promise`<`boolean`>

#### Overrides

[`BaseVectorStore`](../../contract/classes/BaseVectorStore.md).[`hasCollection`](../../contract/classes/BaseVectorStore.md#hascollection)

***

### isAvailable()

```ts
isAvailable(): boolean;
```

Defined in: [batteries/vector/pgvector/index.ts:181](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/pgvector/index.ts#L181)

#### Returns

`boolean`

#### Overrides

[`BaseVectorStore`](../../contract/classes/BaseVectorStore.md).[`isAvailable`](../../contract/classes/BaseVectorStore.md#isavailable)

***

### query()

```ts
query(collection: string): VectorQueryBuilder;
```

Defined in: [batteries/vector/contract.ts:68](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/contract.ts#L68)

#### Parameters

| Parameter    | Type     |
| ------------ | -------- |
| `collection` | `string` |

#### Returns

[`VectorQueryBuilder`](../../builder/classes/VectorQueryBuilder.md)

#### Inherited from

[`BaseVectorStore`](../../contract/classes/BaseVectorStore.md).[`query`](../../contract/classes/BaseVectorStore.md#query)

***

### renameCollection()

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

Defined in: [batteries/vector/pgvector/index.ts:320](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/pgvector/index.ts#L320)

#### Parameters

| Parameter | Type     |
| --------- | -------- |
| `from`    | `string` |
| `to`      | `string` |

#### Returns

`Promise`<`void`>

#### Overrides

[`BaseVectorStore`](../../contract/classes/BaseVectorStore.md).[`renameCollection`](../../contract/classes/BaseVectorStore.md#renamecollection)

***

### transaction()

```ts
transaction(fn: (tx: CallableVectorStore) => Promise<void>): Promise<void>;
```

Defined in: [batteries/vector/pgvector/index.ts:551](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/pgvector/index.ts#L551)

#### Parameters

| Parameter | Type                                                                                                       |
| --------- | ---------------------------------------------------------------------------------------------------------- |
| `fn`      | (`tx`: [`CallableVectorStore`](../../contract/type-aliases/CallableVectorStore.md)) => `Promise`<`void`> |

#### Returns

`Promise`<`void`>

#### Overrides

[`BaseVectorStore`](../../contract/classes/BaseVectorStore.md).[`transaction`](../../contract/classes/BaseVectorStore.md#transaction)

***

### isAvailable()

```ts
static isAvailable(): boolean;
```

Defined in: [batteries/vector/pgvector/index.ts:178](https://github.com/NHTIO/ADK/blob/v1.20260607.0/src/batteries/vector/pgvector/index.ts#L178)

#### Returns

`boolean`