KnexRepository

Defined in: knex-repository.ts:18

Extended by

• KnexVectorRepository

Type Parameters

T

T extends Record<string, unknown>

D

D = Partial<T>

Implements

• Repository<T, D>

Constructors

Constructor

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

Defined in: knex-repository.ts:42

Parameters

app

MantleApplication

Returns

KnexRepository<T, D>

Properties

_trx

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

Defined in: knex-repository.ts:20

---

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.

---

createdAtField

readonly createdAtField: string = "createdAt"

Defined in: knex-repository.ts:26

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

Default

"createdAt"

---

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.

---

idField

readonly idField: string = "id"

Defined in: knex-repository.ts:23

---

knex

protected readonly knex: Knex

Defined in: knex-repository.ts:19

---

tableName

abstract readonly tableName: string

Defined in: knex-repository.ts:22

---

timestamps

readonly timestamps: boolean = true

Defined in: knex-repository.ts:24

---

updatedAtField

readonly updatedAtField: string = "updatedAt"

Defined in: knex-repository.ts:28

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

Default

"updatedAt"

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

---

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[]>

Methods

buildQuery()

protected buildQuery(params?): QueryBuilder

Defined in: knex-repository.ts:94

Parameters

params?

QueryParams

Returns

QueryBuilder

---

count()

count(params?): Promise<number>

Defined in: knex-repository.ts:297

Parameters

params?

QueryParams

Returns

Promise<number>

Implementation of

Repository.count

---

deleteById()

deleteById(id): Promise<T>

Defined in: knex-repository.ts:272

Parameters

id

Id

Returns

Promise<T>

Implementation of

Repository.deleteById

---

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

Repository.describe

---

findAll()

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

Defined in: knex-repository.ts:152

Parameters

params?

QueryParams

Returns

Promise<T[]>

Implementation of

Repository.findAll

---

findById()

findById(id): Promise<T | null>

Defined in: knex-repository.ts:164

Parameters

id

Id

Returns

Promise<T | null>

Implementation of

Repository.findById

---

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>

---

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

---

patchById()

patchById(id, data): Promise<T>

Defined in: knex-repository.ts:243

Parameters

id

Id

data

D

Returns

Promise<T>

Implementation of

Repository.patchById

---

save()

save(data): Promise<T>

Defined in: knex-repository.ts:175

Parameters

data

D

Returns

Promise<T>

Implementation of

Repository.save

---

saveAll()

saveAll(data): Promise<T[]>

Defined in: knex-repository.ts:192

Parameters

data

D[]

Returns

Promise<T[]>

Implementation of

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

---

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

---

updateById()

updateById(id, data): Promise<T>

Defined in: knex-repository.ts:217

Parameters

id

Id

data

D

Returns

Promise<T>

Implementation of

Repository.updateById

---

withTransaction()

withTransaction<R>(callback): Promise<R>

Defined in: knex-repository.ts:69

Run a set of repository operations inside a single database transaction. The callback receives a transaction-scoped copy of this repository.

Type Parameters

R

R

Parameters

callback

(repo) => Promise<R>

Returns

Promise<R>

---

wrapError()

protected wrapError(err): Error

Defined in: knex-repository.ts:313

Parameters

err

unknown

Returns

Error