KnexVectorRepository

Defined in: knex-vector-repository.ts:13

Extends KnexRepository with pgvector support for PostgreSQL. Subclasses must be connected to a pg client — vector methods throw GeneralError on other databases.

Extends

KnexRepository<T, D>

Type Parameters

T

T extends Record<string, unknown>

D

D = Partial<T>

Implements

VectorRepository<T, D>

Constructors

Constructor

new KnexVectorRepository<T, D>(app): KnexVectorRepository<T, D>

Defined in: knex-repository.ts:42

Parameters

app

MantleApplication

Returns

KnexVectorRepository<T, D>

Inherited from

KnexRepository.constructor

Properties

_trx

protected _trx: Transaction<any, any[]> | null = null

Defined in: knex-repository.ts:20

Inherited from

KnexRepository._trx

columnCase

readonly columnCase: "camelCase" | "snake_case" = "camelCase"

Defined in: knex-repository.ts:35

Naming convention used to derive column names from entity field names. “camelCase” (default) uses entity field names verbatim as column names. “snake_case” converts every field automatically (userId -> user_id) so the entity/type can stay camelCase while the table uses snake_case columns.

Inherited from

KnexRepository.columnCase

createdAtField

readonly createdAtField: string = "createdAt"

Defined in: knex-repository.ts:26

Entity-side field written for auto-managed creation timestamps.

Default

"createdAt"

Inherited from

KnexRepository.createdAtField

distanceOperator

readonly distanceOperator: DistanceOperator = "<=>"

Defined in: knex-vector-repository.ts:18

fieldMap

readonly fieldMap: Record<string, string> = {}

Defined in: knex-repository.ts:40

Explicit entity-field-to-column overrides, applied before columnCase conversion. Use this for individual columns that don’t follow the table’s general convention.

Inherited from

KnexRepository.fieldMap

idField

readonly idField: string = "id"

Defined in: knex-repository.ts:23

Inherited from

KnexRepository.idField

knex

protected readonly knex: Knex

Defined in: knex-repository.ts:19

Inherited from

KnexRepository.knex

tableName

abstract readonly tableName: string

Defined in: knex-repository.ts:22

Inherited from

KnexRepository.tableName

timestamps

readonly timestamps: boolean = true

Defined in: knex-repository.ts:24

Inherited from

KnexRepository.timestamps

updatedAtField

readonly updatedAtField: string = "updatedAt"

Defined in: knex-repository.ts:28

Entity-side field written for auto-managed update timestamps.

Default

"updatedAt"

Inherited from

KnexRepository.updatedAtField

vectorColumn

readonly vectorColumn: string = "embedding"

Defined in: knex-vector-repository.ts:17

Accessors

db

Get Signature

get db(): QueryBuilder

Defined in: knex-repository.ts:47

Raw query builder for this table, respecting any active transaction.

Returns

QueryBuilder

Inherited from

KnexRepository.db

qb

Get Signature

get protected qb(): Knex<any, any[]> | Transaction<any, any[]>

Defined in: knex-repository.ts:79

Returns

Knex<any, any[]> | Transaction<any, any[]>

Inherited from

KnexRepository.qb

Methods

buildQuery()

protected buildQuery(params?): QueryBuilder

Defined in: knex-repository.ts:94

Parameters

params?

QueryParams

Returns

QueryBuilder

Inherited from

KnexRepository.buildQuery

count()

count(params?): Promise<number>

Defined in: knex-repository.ts:297

Parameters

params?

QueryParams

Returns

Promise<number>

Implementation of

VectorRepository.count

Inherited from

KnexRepository.count

deleteById()

deleteById(id): Promise<T>

Defined in: knex-repository.ts:272

Parameters

id

Id

Returns

Promise<T>

Implementation of

VectorRepository.deleteById

Inherited from

KnexRepository.deleteById

deleteVector()

deleteVector(id): Promise<T>

Defined in: knex-vector-repository.ts:119

Delete a record and its associated vector by id.

Parameters

id

Id

Returns

Promise<T>

Implementation of

VectorRepository.deleteVector

describe()

describe(): RepositoryCapabilities

Defined in: knex-repository.ts:51

Optional capability introspection. All

Returns

RepositoryCapabilities

Mantlejs

adapters implement it; user repositories may omit it.

Implementation of

VectorRepository.describe

Inherited from

KnexRepository.describe

findAll()

findAll(params?): Promise<T[]>

Defined in: knex-repository.ts:152

Parameters

params?

QueryParams

Returns

Promise<T[]>

Implementation of

VectorRepository.findAll

Inherited from

KnexRepository.findAll

findById()

findById(id): Promise<T | null>

Defined in: knex-repository.ts:164

Parameters

id

Id

Returns

Promise<T | null>

Implementation of

VectorRepository.findById

Inherited from

KnexRepository.findById

findSimilar()

findSimilar(vector, topK, params?): Promise<T & object[]>

Defined in: knex-vector-repository.ts:37

Find the top-K records most similar to the given embedding vector. Results include a synthetic _score column with the computed pgvector distance — LOWER is more similar (it is a distance, not a similarity). Generates: SELECT *, $1::vector AS _score FROM

ORDER BY $1::vector LIMIT $2

Parameters

vector

number[]

topK

number

params?

QueryParams

Returns

Promise<T & object[]>

Implementation of

VectorRepository.findSimilar

mapDataToColumns()

protected mapDataToColumns(data): Record<string, unknown>

Defined in: knex-repository.ts:130

Renames the keys of a data payload from entity field names to column names.

Parameters

data

Record<string, unknown>

Returns

Record<string, unknown>

Inherited from

KnexRepository.mapDataToColumns

mapRowToEntity()

protected mapRowToEntity(row): T

Defined in: knex-repository.ts:135

Renames the keys of a returned row from column names to entity field names.

Parameters

row

Record<string, unknown>

Returns

T

Inherited from

KnexRepository.mapRowToEntity

patchById()

patchById(id, data): Promise<T>

Defined in: knex-repository.ts:243

Parameters

id

Id

data

D

Returns

Promise<T>

Implementation of

VectorRepository.patchById

Inherited from

KnexRepository.patchById

save()

save(data): Promise<T>

Defined in: knex-repository.ts:175

Parameters

data

D

Returns

Promise<T>

Implementation of

VectorRepository.save

Inherited from

KnexRepository.save

saveAll()

saveAll(data): Promise<T[]>

Defined in: knex-repository.ts:192

Parameters

data

D[]

Returns

Promise<T[]>

Implementation of

VectorRepository.saveAll

Inherited from

KnexRepository.saveAll

toColumn()

protected toColumn(field): string

Defined in: knex-repository.ts:117

Translates an entity field name to its column name (fieldMap override, then columnCase convention).

Parameters

field

string

Returns

string

Inherited from

KnexRepository.toColumn

toEntityField()

protected toEntityField(column): string

Defined in: knex-repository.ts:123

Translates a column name back to its entity field name — the inverse of toColumn.

Parameters

column

string

Returns

string

Inherited from

KnexRepository.toEntityField

updateById()

updateById(id, data): Promise<T>

Defined in: knex-repository.ts:217

Parameters

id

Id

data

D

Returns

Promise<T>

Implementation of

VectorRepository.updateById

Inherited from

KnexRepository.updateById

upsertVector()

upsertVector(id, vector, data): Promise<T>

Defined in: knex-vector-repository.ts:82

Upsert a record with its embedding vector: updates the vector and data columns on an existing row (but not createdAt), or inserts a new one.

Deliberately an UPDATE followed by a conditional INSERT rather than a single INSERT ... ON CONFLICT DO UPDATE — Postgres validates NOT NULL constraints on the full candidate insert tuple before checking for a conflict, so a single-statement upsert that only lists the id/vector/timestamp columns fails on any other NOT NULL column (e.g. a required title) even when the conflicting row already has one. Not atomic: a concurrent upsertVector on the same id between the UPDATE and the INSERT could race to insert twice.