Skip to main content

SQLRepository

@webda/postgres

Class: SQLRepository<T>

Defined in: sql/lib/repository.d.ts:12

SQL-backed repository for a single model class: one JSON data column per uuid row.

Every statement is assembled from the fragments of a SQLDialect, so the same logic runs on every engine. The inherited MemoryRepository serialize/deserialize helpers are reused for JSON to model-instance conversion.

Extends​

  • MemoryRepository<T>

Extended by​

Type Parameters​

T​

T extends ModelClass

Constructors​

Constructor​

new SQLRepository<T>(model, pks, client, table, separator, prepare, tableModel, dialect): SQLRepository<T>

Defined in: sql/lib/repository.d.ts:28

Create a new SQLRepository.

Parameters​

model​

T

the model class

pks​

string[]

primary key field names

client​

SQLClient | (() => SQLClient | undefined)

the client, or a function returning the store's current one: the repository then follows the client the store connects in init(), even when created before it or kept across a stop()

table​

string

the table name

separator​

string | undefined

composite key separator

prepare​

(() => Promise<void>) | undefined

awaited before every statement (e.g. to ensure the table exists)

tableModel​

string | undefined

identifier of the model the table was declared for: rows without __type (written before stamping) belong to it. Defaults to the topmost ancestor of model carrying metadata.

dialect​

SQLDialect

the engine syntax

Returns​

SQLRepository<T>

Overrides​

MemoryRepository<T>.constructor

Properties​

[WEBDA_TEST]​

[WEBDA_TEST]: object

Defined in: models/lib/repositories/memory.d.ts:325

Test utilities - clears all stored data

clear​

clear: () => Promise<void>

Returns​

Promise<void>

Inherited from​

MemoryRepository.[WEBDA_TEST]

aggregationOptions​

protected aggregationOptions: AggregationOptions

Defined in: models/lib/repositories/abstract.d.ts:27

Aggregation fallback policy, set by the owning store through configureAggregation

Inherited from​

SQLRepository.aggregationOptions

dialect​

protected readonly dialect: SQLDialect

Defined in: sql/lib/repository.d.ts:14

events​

protected events: Map<keyof InstanceType<T>[typeof WEBDA_EVENTS], Set<(data) => void>>

Defined in: models/lib/repositories/abstract.d.ts:25

Registered event listeners keyed by event name

Inherited from​

MemoryRepository.events

maxListeners​

protected maxListeners: number

Defined in: models/lib/repositories/abstract.d.ts:321

Max-listeners hint kept for Node EventEmitter API compatibility. Not enforced — repositories use an unbounded Set per event.

Inherited from​

SQLRepository.maxListeners

model​

protected model: T

Defined in: models/lib/repositories/abstract.d.ts:21

Inherited from​

MemoryRepository.model

monitorOptions​

protected monitorOptions: QueryMonitorOptions

Defined in: models/lib/repositories/abstract.d.ts:29

Query monitoring options, set by the owning store through configureMonitoring

Inherited from​

SQLRepository.monitorOptions

pks​

protected pks: string[]

Defined in: models/lib/repositories/abstract.d.ts:22

Inherited from​

SQLRepository.pks

prepare?​

protected readonly optional prepare?: () => Promise<void>

Defined in: sql/lib/repository.d.ts:32

Awaited before every statement (e.g. to ensure the table exists)

Returns​

Promise<void>

separator​

protected separator: string

Defined in: models/lib/repositories/abstract.d.ts:23

Inherited from​

SQLRepository.separator

storage​

protected storage: Map

Defined in: models/lib/repositories/memory.d.ts:39

Inherited from​

MemoryRepository.storage

table​

protected readonly table: string

Defined in: sql/lib/repository.d.ts:13

tableModel?​

protected readonly optional tableModel?: string

Defined in: sql/lib/repository.d.ts:40

Identifier of the model the table was declared for: unstamped rows belong to it

tableRoot?​

protected optional tableRoot?: ModelClass<Storable<any, any>>

Defined in: models/lib/repositories/abstract.d.ts:35

Model owning the untyped rows of the storage (the first model of the store), undefined when not known

Inherited from​

SQLRepository.tableRoot

warnedAggregations​

protected warnedAggregations: Set<string>

Defined in: models/lib/repositories/abstract.d.ts:31

Fallback shapes already warned about

Inherited from​

SQLRepository.warnedAggregations

Accessors​

client​

Get Signature​

get protected client(): SQLClient

Defined in: sql/lib/repository.d.ts:49

The client the statements run on

Resolved on every access: a repository handed out before its store connected (Store.computeStores asks every store for its repositories from the first store init) or kept across a stop()/init() cycle uses the current one.

Throws​

when the store has no client, i.e. is not initialized or is stopped

Returns​

SQLClient

the client

Methods​

__clean()​

__clean(): Promise<void>

Defined in: sql/lib/repository.d.ts:274

Delete all rows from the table (used in tests).

Returns​

Promise<void>

acceptedTypes()​

acceptedTypes(): string[]

Defined in: models/lib/repositories/abstract.d.ts:69

Every stored __type value of this model and its transitive subclasses, for stores filtering in their query language

Returns​

string[]

the values, empty when the model carries no Metadata

Inherited from​

MemoryRepository.acceptedTypes

aggregate()​

aggregate<G, M>(spec, params?): Promise<AggregationResult<AggregatedRow<InstanceType<T>, G, M>>>

Defined in: models/lib/repositories/abstract.d.ts:256

Keep the full generic signature here (not spec: any): concrete repositories are used directly in code and tests, and must expose the typed rows.

Type Parameters​

G​

G extends readonly _NonFunctionPropertyPaths<InstanceType<T>>[] = []

M​

M extends Record<string, MetricSpec<InstanceType<T>>> = Record<string, MetricSpec<InstanceType<T>>>

Parameters​

spec​

AggregationSpec<InstanceType<T>, G, M>

params?​

QueryParameters

Returns​

Promise<AggregationResult<AggregatedRow<InstanceType<T>, G, M>>>

Inherited from​

MemoryRepository.aggregate

aggregateInMemory()​

protected aggregateInMemory(query): Promise<Record<string, unknown>[]>

Defined in: models/lib/repositories/abstract.d.ts:301

Aggregate by streaming the filtered items

Parameters​

query​

AggregationQuery

the aggregation

Returns​

Promise<Record<string, unknown>[]>

the rows

Inherited from​

MemoryRepository.aggregateInMemory

applyAssignments()​

protected applyAssignments<O>(target, assignments): O

Defined in: models/lib/repositories/abstract.d.ts:166

Set the assignments of an UPDATE on an object, creating the intermediate objects of dotted paths

Targets were checked by parseStatement: letters, digits and _ only, no __ segment, no Object.prototype member name.

Type Parameters​

O​

O

Parameters​

target​

O

the object to change in place

assignments​

Assignment[]

the SET assignments

Returns​

O

the target

Inherited from​

MemoryRepository.applyAssignments

backfillTypes()​

backfillTypes(): Promise<number>

Defined in: sql/lib/repository.d.ts:63

Stamp the rows written before __type stamping with the table model: they keep belonging to it, and a later change of the table model cannot reassign them

Idempotent; only the repository of the table model writes. Equivalent SQL (PostgreSQL): UPDATE <table> SET data = data || jsonb_build_object('__type', '<table model>') WHERE data->>'__type' IS NULL.

Returns​

Promise<number>

the number of rows stamped

belongsToModel()​

belongsToModel(stored?): boolean

Defined in: models/lib/repositories/abstract.d.ts:75

Whether a stored row belongs to this model, for stores filtering in memory

Parameters​

stored?​

string

the stored __type, undefined for an untyped row

Returns​

boolean

true when the row belongs to this model (always without Metadata)

Inherited from​

MemoryRepository.belongsToModel

buildAggregationSQL()​

buildAggregationSQL(query, where?): object

Defined in: sql/lib/repository.d.ts:226

Translate an aggregation to SQL

The query is validated again here and paths are checked once more, so they are safe to interpolate. Columns get positional names (gN per group path, mN / nN / sN per metric index), mapped back to the aliases by decode: alias length or shared prefixes never meet an identifier length limit. MIN / MAX select a numeric and a text candidate, merged by decode.

Parameters​

query​

AggregationQuery

the aggregation

where?​

string

extra WHERE condition (class condition), optional

Returns​

object

the statement and the row decoder

decode​

decode: (row) => any

Parameters​
row​

any

Returns​

any

sql​

sql: string

buildClassFilter()​

protected buildClassFilter(): string | undefined

Defined in: models/lib/repositories/memory.d.ts:186

Build the WebdaQL class-filter clause __type IN ['A', 'B', ...] covering this.model's identifier and every transitive descendant.

Returns undefined when the model carries no Metadata.

Returns​

string | undefined

the class-filter WebdaQL clause, or undefined when no Metadata

Inherited from​

MemoryRepository.buildClassFilter

buildClassFilterIdentifiers()​

protected buildClassFilterIdentifiers(): string[] | undefined

Defined in: models/lib/repositories/memory.d.ts:177

Collect the WebdaQL class-filter identifier list — this.model's identifier and every transitive descendant.

Returns undefined when the model carries no Metadata (plain unit-test classes that didn't go through Application.setModelMetadata). In that case query() skips the prepend and returns everything in storage, preserving the pre-fix behavior for those bare classes.

Returns​

string[] | undefined

the list of identifiers to match, or undefined when no Metadata

Inherited from​

MemoryRepository.buildClassFilterIdentifiers

buildCountSQL()​

buildCountSQL(filter, max?): string

Defined in: sql/lib/repository.d.ts:245

Translate a count to SQL: one COUNT(*) over the filter, or over a sub-select stopped at max + 1 rows so a capped count reads at most max + 1 rows

Parameters​

filter​

Expression

the WebdaQL filter

max?​

number

stop after max rows, undefined for an exact count

Returns​

string

the statement, its n column holds the count

buildItem()​

protected buildItem(data): InstanceType<T>

Defined in: models/lib/repositories/abstract.d.ts:86

Build the model instance to create from the incoming data

Primary key fields that are undefined or null are dropped from the data so a key generated by the model constructor (e.g. UuidModel) is not overwritten. Repositories must read the storage key from the returned instance.

Parameters​

data​

Helpers<InstanceType<T>>

the incoming data

Returns​

InstanceType<T>

the model instance

Inherited from​

MemoryRepository.buildItem

checkAggregationFallback()​

protected checkAggregationFallback(query, reason): Promise<void>

Defined in: models/lib/repositories/abstract.d.ts:272

Apply the fallback policy before aggregating or counting in memory

Parameters​

query​

AggregationQuery | undefined

the aggregation, undefined for a count

reason​

string

why it cannot run natively

Returns​

Promise<void>

Throws​

AggregationError AGGREGATION_NOT_NATIVE when the policy is deny

Inherited from​

MemoryRepository.checkAggregationFallback

checkCondition()​

protected checkCondition<K>(item, conditionField?, condition?): void

Defined in: models/lib/repositories/memory.d.ts:67

Verify an optimistic locking condition on an item

Type Parameters​

K​

K extends string

Parameters​

item​

InstanceType<T>

The item to check

conditionField?​

K | null

Field to validate

condition?​

any

Expected value

Returns​

void

Throws​

Error if the condition does not match

Inherited from​

MemoryRepository.checkCondition

checkItemWriteCondition()​

protected checkItemWriteCondition(item, index, itemWriteConditionField, itemWriteCondition): void

Defined in: models/lib/repositories/memory.d.ts:317

Verify a write condition on a collection item

Parameters​

item​

any[]

The array to check

index​

number

Index of the item in the array

itemWriteConditionField​

string

Field name to check on the item

itemWriteCondition​

any

Expected value for the field

Returns​

void

Throws​

Error if the condition does not match

Inherited from​

MemoryRepository.checkItemWriteCondition

checkPath()​

protected checkPath(attribute): string[]

Defined in: sql/lib/repository.d.ts:104

Check the segments of a path written inside a SQL literal: letters, digits and _, like WebdaQL identifiers

Parameters​

attribute​

string[]

the attribute path

Returns​

string[]

the validated segments

Throws​

Error for any other character

collectStatementKeys()​

protected collectStatementKeys(statement): Promise<PrimaryKeyType<InstanceType<T>>[]>

Defined in: models/lib/repositories/abstract.d.ts:173

Keys of the objects matching the WHERE of a statement, collected before any change so an update changing a WHERE field cannot meet the same object twice; at most LIMIT keys

Parameters​

statement​

Query

the parsed statement

Returns​

Promise<PrimaryKeyType<InstanceType<T>>[]>

the primary keys

Inherited from​

MemoryRepository.collectStatementKeys

configureAggregation()​

configureAggregation(options): void

Defined in: models/lib/repositories/abstract.d.ts:228

Copy the known options (fallback, maxGroups, warn); undefined values keep the current ones

Parameters​

options​

Partial<AggregationOptions>

Returns​

void

Throws​

Error when maxGroups is not a positive integer or fallback is unknown

Inherited from​

MemoryRepository.configureAggregation

configureMonitoring()​

configureMonitoring(options): void

Defined in: models/lib/repositories/abstract.d.ts:233

Configure the query monitoring policy, called by the owning store

Parameters​

options​

Partial<QueryMonitorOptions>

options to override

Returns​

void

Inherited from​

MemoryRepository.configureMonitoring

count()​

count(filter?, params?, options?): Promise<CountResult>

Defined in: models/lib/repositories/abstract.d.ts:278

Parse the filter, refuse statements, drop ORDER BY / LIMIT / OFFSET and run executeCount

Parameters​

filter?​

string

params?​

QueryParameters

options?​

CountOptions

Returns​

Promise<CountResult>

Throws​

Error when max is not a positive integer

Inherited from​

MemoryRepository.count

countInMemory()​

protected countInMemory(filter, max?): Promise<Omit<CountResult, "native">>

Defined in: models/lib/repositories/abstract.d.ts:295

Count by streaming the filtered items, stopping at max + 1

Parameters​

filter​

Expression

the filter

max?​

number

stop after max objects, undefined for an exact count

Returns​

Promise<Omit<CountResult, "native">>

the value and its relation

Inherited from​

MemoryRepository.countInMemory

create()​

create(data, _save?): Promise<any>

Defined in: sql/lib/repository.d.ts:181

Parameters​

data​

any

_save?​

boolean

Returns​

Promise<any>

Overrides​

MemoryRepository.create

currentTypeOf()​

protected currentTypeOf(instance, stored?): string | undefined

Defined in: models/lib/repositories/memory.d.ts:140

The __type to attach to a loaded instance: the current identifier of its class, the stored value when it is unknown or ambiguous (never rewritten to a guess), the repository model identifier for an untyped row

Parameters​

instance​

any

the loaded instance

stored?​

string

the stored __type

Returns​

string | undefined

the value to attach

Inherited from​

MemoryRepository.currentTypeOf

declaredType()​

protected declaredType(item): string | undefined

Defined in: sql/lib/repository.d.ts:143

The type an object written by the application declares: the __type its row was read with (non-enumerable, set by fromJSON), else the identifier of its class. Plain data declares none, whatever its keys.

Parameters​

item​

any

the object

Returns​

string | undefined

the model identifier, undefined for plain data

delete()​

delete(primaryKey, conditionField?, condition?): Promise<void>

Defined in: sql/lib/repository.d.ts:187

Parameters​

primaryKey​

any

conditionField?​

any

condition?​

any

Returns​

Promise<void>

Overrides​

MemoryRepository.delete

deleteItemFromCollection()​

deleteItemFromCollection(primaryKey, collection, index, itemWriteConditionField?, itemWriteCondition?): Promise<void>

Defined in: sql/lib/repository.d.ts:197

Parameters​

primaryKey​

any

collection​

any

index​

number

itemWriteConditionField?​

any

itemWriteCondition?​

any

Returns​

Promise<void>

Overrides​

MemoryRepository.deleteItemFromCollection

deleteMany()​

deleteMany(statement, params?): Promise<number>

Defined in: sql/lib/repository.d.ts:259

Delete in bulk with one DELETE ... WHERE: no per-object event (see Repository.deleteMany)

Parameters​

statement​

string | Query

params?​

QueryParameters

Returns​

Promise<number>

Overrides​

MemoryRepository.deleteMany

deleteManyByKey()​

protected deleteManyByKey(statement, params?): Promise<number>

Defined in: models/lib/repositories/abstract.d.ts:191

Generic deleteMany: collect the matching keys (up to LIMIT), then delete them one by one with this repository's delete primitive

Used by stores without a native bulk delete. On a store repository the primitive emits no event.

Parameters​

statement​

string | Query

the DELETE statement or its parsed form

params?​

QueryParameters

values for the placeholders

Returns​

Promise<number>

the number of objects deleted

Inherited from​

MemoryRepository.deleteManyByKey

deserialize()​

deserialize(item): InstanceType<T>

Defined in: models/lib/repositories/memory.d.ts:121

Unserialize the object from a string

Beyond restoring the concrete type via @webda/serialize's $serializer.type typeKey, this also surfaces the storage envelope's __type stamp on the in-memory instance as a NON-ENUMERABLE property. The non-enumerable bit keeps __type invisible to JSON.stringify and Object.keys (so API responses and re-serialize cycles are byte-identical for the model's own fields), while still being readable via direct property access — which is exactly how WebdaQL's filter eval reads it (ComparisonExpression.getAttributeValue walks obj[name]).

Backward-compat: legacy rows written before the envelope-stamping was introduced won't carry __type. In that case we backfill from the repository's own model.Metadata.Identifier so they look like records of the parent class — which is exactly what query()'s prepended class filter expects (parent + descendants). Plain unit-test classes without Metadata get no stamp at all; their repos opt out of class filtering on the query side too (see query).

Parameters​

item​

string

the serialized string

Returns​

InstanceType<T>

the deserialized model instance

Inherited from​

MemoryRepository.deserialize

deserializeEnvelope()​

protected deserializeEnvelope(item, raw, stored?): any

Defined in: models/lib/repositories/memory.d.ts:132

Deserialize a serializer envelope

A row written under a model's former identifier (renamed, see @WebdaAlias) names a serializer that no longer exists: it is deserialized with the serializer of the class its __type resolves to.

Parameters​

item​

string

the stored string

raw​

any

the parsed envelope

stored?​

string

the stored __type

Returns​

any

the instance

Inherited from​

MemoryRepository.deserializeEnvelope

duplicateExpression()​

duplicateExpression(expression): Expression

Defined in: sql/lib/repository.d.ts:203

Duplicate and translate a WebdaQL expression into SQL JSON path expressions.

Parameters​

expression​

Expression

the WebdaQL expression

Returns​

Expression

the translated expression

emit()​

emit<K>(event, data): Promise<void>

Defined in: models/lib/repositories/abstract.d.ts:346

Emit an event to all registered listeners and await their completion.

Type Parameters​

K​

K extends string | number | symbol

Parameters​

event​

K

The event name to emit

data​

InstanceType<T>[typeof WEBDA_EVENTS][K]

The event payload

Returns​

Promise<void>

Inherited from​

MemoryRepository.emit

excludePrimaryKey()​

excludePrimaryKey(object): any

Defined in: models/lib/repositories/abstract.d.ts:110

Parameters​

object​

any

Returns​

any

Inherited from​

MemoryRepository.excludePrimaryKey

execute()​

protected execute(q, values?): Promise<{ rowCount: number; rows: any[]; }>

Defined in: sql/lib/repository.d.ts:82

Run a statement against the client once prepare has resolved.

Parameters​

q​

string

the SQL statement

values?​

any[]

the statement parameters

Returns​

Promise<{ rowCount: number; rows: any[]; }>

the raw query result

executeAggregation()​

protected executeAggregation(query): Promise<AggregationResult<any>>

Defined in: sql/lib/repository.d.ts:231

GROUP BY over the data JSON column

Parameters​

query​

AggregationQuery

Returns​

Promise<AggregationResult<any>>

Overrides​

MemoryRepository.executeAggregation

executeCount()​

protected executeCount(filter, max?): Promise<CountResult>

Defined in: sql/lib/repository.d.ts:247

COUNT(*) over the data JSON column

Parameters​

filter​

Expression

max?​

number

Returns​

Promise<CountResult>

Overrides​

MemoryRepository.executeCount

exists()​

exists(primaryKey): Promise<boolean>

Defined in: sql/lib/repository.d.ts:189

Parameters​

primaryKey​

any

Returns​

Promise<boolean>

Overrides​

MemoryRepository.exists

findModelClass()​

protected findModelClass(identifier): any

Defined in: models/lib/repositories/memory.d.ts:157

Find the class to hydrate a row typed identifier (a Webda 3 legacy form included): the resolved model when it is the repository model or one of its transitive subclasses, the repository model for an ancestor type or an unknown or ambiguous type

Parameters​

identifier​

string

stored __type

Returns​

any

the class, this.model when it carries no Metadata, or undefined for an unrelated model

Inherited from​

MemoryRepository.findModelClass

fromJSON()​

protected fromJSON(stored): InstanceType<T>

Defined in: sql/lib/repository.d.ts:177

Deserialize a raw JSON object from the database into a model instance.

Parameters​

stored​

any

the decoded JSON object of the data column; its __type stamp becomes a non-enumerable property

Returns​

InstanceType<T>

the model instance

fromUID()​

fromUID(uid): ModelRefWithCreate<InstanceType<T>>

Defined in: models/lib/repositories/abstract.d.ts:92

Return a ref from the uuid

Parameters​

uid​

string

the serialized primary key

Returns​

ModelRefWithCreate<InstanceType<T>>

a model reference with create capability

Inherited from​

MemoryRepository.fromUID

get()​

get(primaryKey): Promise<any>

Defined in: sql/lib/repository.d.ts:179

Parameters​

primaryKey​

any

Returns​

Promise<any>

Overrides​

MemoryRepository.get

getAllowedFields()​

getAllowedFields(): string[] | undefined

Defined in: models/lib/repositories/abstract.d.ts:138

Field paths of the model, from its metadata (Reflection and the stored, input and output schemas)

Used to validate UPDATE SET targets.

Returns​

string[] | undefined

the field names, undefined when the model carries no field metadata (no validation then)

Inherited from​

MemoryRepository.getAllowedFields

getClassCondition()​

protected getClassCondition(): string | undefined

Defined in: sql/lib/repository.d.ts:111

SQL condition restricting rows to this model and its subclasses, whatever form their __type has (Webda 3 short, lower-case and aliased types included); rows without a stamp (written before stamping) and rows typed as a strict ancestor of the table model belong to the table model and its ancestors

Returns​

string | undefined

the condition, undefined for a model without metadata

getCompletionFields()​

getCompletionFields(): CompletionField[]

Defined in: models/lib/repositories/abstract.d.ts:143

Completion fields of the model, flattened from its schemas

Returns​

CompletionField[]

array of completion fields

Inherited from​

MemoryRepository.getCompletionFields

getFilterCondition()​

protected getFilterCondition(filter): string

Defined in: sql/lib/repository.d.ts:237

SQL condition selecting the rows of this model matching a filter: the filter and the class condition

Parameters​

filter​

Expression

the WebdaQL filter

Returns​

string

the condition

getMaxListeners()​

getMaxListeners(): number

Defined in: models/lib/repositories/abstract.d.ts:334

EventEmitter-compatibility shim. Returns the max-listeners hint.

Returns​

number

the current max-listeners hint

Inherited from​

MemoryRepository.getMaxListeners

getPrimaryKey()​

Call Signature​

getPrimaryKey(object, forceObject?): PrimaryKeyType<InstanceType<T>>

Defined in: models/lib/repositories/abstract.d.ts:112

Get the primary key value for an object as a scalar or string.

Parameters​
object​

any

forceObject?​

false

Returns​

PrimaryKeyType<InstanceType<T>>

Inherited from​

MemoryRepository.getPrimaryKey

Call Signature​

getPrimaryKey(object, forceObject): PrimaryKey<InstanceType<T>>

Defined in: models/lib/repositories/abstract.d.ts:114

Get the primary key value for an object as a structured key object.

Parameters​
object​

any

forceObject​

true

Returns​

PrimaryKey<InstanceType<T>>

Inherited from​

MemoryRepository.getPrimaryKey

getQueryCondition()​

getQueryCondition(writeCondition, writeConditionField, params): string

Defined in: sql/lib/repository.d.ts:161

Build a SQL WHERE sub-expression from a write-condition.

An undefined or null expected value means the field is absent: it is matched with IS NULL, as = NULL is never true in SQL (a missing key and a JSON null both read as NULL)

Parameters​

writeCondition​

any

the expected value

writeConditionField​

string

the field to check

params​

any[]

the existing params array (will be extended in place)

Returns​

string

the SQL AND clause

getRootModel()​

getRootModel(): T

Defined in: models/lib/repositories/abstract.d.ts:47

Returns​

T

Inherited from​

MemoryRepository.getRootModel

getStatementCondition()​

protected getStatementCondition(statement): string

Defined in: sql/lib/repository.d.ts:254

SQL condition selecting the rows a statement targets: its WHERE, restricted to the first LIMIT rows when the statement has a LIMIT (DELETE and UPDATE have none on every engine)

Parameters​

statement​

Query

the parsed statement

Returns​

string

the condition

getSync()​

protected getSync(primaryKey): InstanceType<T>

Defined in: models/lib/repositories/memory.d.ts:55

Synchronous read used by conditional writes to keep check-and-set atomic

Parameters​

primaryKey​

string | PK<InstanceType<T>, InstanceType<T>[typeof WEBDA_PRIMARY_KEY][number]>

key of the item

Returns​

InstanceType<T>

the deserialized item

Inherited from​

MemoryRepository.getSync

getTable()​

getTable(): string

Defined in: sql/lib/repository.d.ts:69

Internal

The backing table name for this repository's model.

Returns​

string

the table name Not part of the @webda/models Repository interface.

getTableRoot()​

getTableRoot(): ModelClass<Storable<any, any>> | undefined

Defined in: models/lib/repositories/abstract.d.ts:57

Returns​

ModelClass<Storable<any, any>> | undefined

the model owning the untyped rows of the storage

Inherited from​

MemoryRepository.getTableRoot

getUID()​

getUID(object): string

Defined in: models/lib/repositories/abstract.d.ts:116

Parameters​

object​

any

Returns​

string

Inherited from​

MemoryRepository.getUID

hydratePlainRow()​

protected hydratePlainRow(raw): InstanceType<T>

Defined in: models/lib/repositories/memory.d.ts:165

Hydrate a plain JSON row as an instance of the repository model (or of the transitive subclass named by its __type; an ancestor type hydrates as the repository model), the same way document stores hydrate their rows; a row typed as an unrelated model is refused

Parameters​

raw​

any

the parsed row

Returns​

InstanceType<T>

the model instance

Inherited from​

MemoryRepository.hydratePlainRow

incrementAttribute()​

incrementAttribute<K, L>(primaryKey, info, _conditionField?, _condition?): Promise<void>

Defined in: models/lib/repositories/abstract.d.ts:124

Type Parameters​

K​

K extends string

L​

L extends string

Parameters​

primaryKey​

PK<InstanceType<T>, InstanceType<T>[typeof WEBDA_PRIMARY_KEY][number]>

info​

L | { property: L; value?: number; }

_conditionField?​

K | null

_condition?​

any

Returns​

Promise<void>

Inherited from​

MemoryRepository.incrementAttribute

incrementAttributes()​

incrementAttributes(primaryKey, info, _conditionField?, _condition?): Promise<void>

Defined in: sql/lib/repository.d.ts:193

Parameters​

primaryKey​

any

info​

any

_conditionField?​

any

_condition?​

any

Returns​

Promise<void>

Overrides​

MemoryRepository.incrementAttributes

isPlainRow()​

protected isPlainRow(raw): boolean

Defined in: models/lib/repositories/memory.d.ts:149

Whether a stored row is a plain JSON object without a serializer envelope

Rows written by earlier versions (e.g. a v3 FileStore folder or MemoryStore persistence file) store the object itself, its type in a top-level __type.

Parameters​

raw​

any

the parsed row

Returns​

boolean

true for a plain object row

Inherited from​

MemoryRepository.isPlainRow

iterate()​

iterate(queryStr): AsyncGenerator<InstanceType<T>, any, any>

Defined in: sql/lib/repository.d.ts:270

— iterate via paginated SQL queries

Parameters​

queryStr​

string

Returns​

AsyncGenerator<InstanceType<T>, any, any>

Overrides​

MemoryRepository.iterate

jsonPath()​

protected jsonPath(path): string

Defined in: sql/lib/repository.d.ts:214

JSON expression of a dotted path, JSON null folded into SQL NULL

Parameters​

path​

string

validated dotted path

Returns​

string

the SQL expression

keptTypeExpression()​

protected keptTypeExpression(mapParam): string

Defined in: sql/lib/repository.d.ts:136

SQL expression of the __type a written row keeps: its stored type, rewritten to the current identifier when it is a legacy form of this model family

Parameters​

mapParam​

number

position of the bound legacyTypeMap parameter

Returns​

string

the SQL expression

legacyTypeMap()​

protected legacyTypeMap(): Record<string, string>

Defined in: sql/lib/repository.d.ts:129

Stored types to rewrite when a row of this model family is written: each legacy form (short, lower-case, alias) to its current identifier, and the ancestor types of the table model to the table model

Returns​

Record<string, string>

the current identifier by lower-cased stored type

listKeysOfModel()​

protected listKeysOfModel(ids?): string[]

Defined in: models/lib/repositories/memory.d.ts:230

List the storage keys that may belong to this model

A storage shared by several models holds foreign entries whose key shape can be invalid for this repository: they are skipped from the stored __type before any parsing. Entries are kept when their stored __type belongs to the model (legacy forms included). Untyped entries, and entries typed as a strict ancestor of the table root, belong to the table root and its ancestors. Unreadable entries are kept so their error surfaces.

A TypeIndexedMap storage answers from its type index: only the keys of the model are visited. Any other Map-like storage is scanned, parsing every entry.

Parameters​

ids?​

string[]

class identifiers (model and subclasses), undefined to keep everything

Returns​

string[]

the keys to evaluate

Inherited from​

MemoryRepository.listKeysOfModel

mapExpressionAttribute()​

mapExpressionAttribute(attribute): string

Defined in: sql/lib/repository.d.ts:91

Map an expression attribute path array to the SQL text of the value

Parameters​

attribute​

string[]

the attribute path

Returns​

string

the SQL expression

mapJsonAttribute()​

mapJsonAttribute(attribute): string

Defined in: sql/lib/repository.d.ts:97

Map an expression attribute path array to its JSON value (not its text)

Parameters​

attribute​

string[]

the attribute path

Returns​

string

the SQL expression

matchStorage()​

protected matchStorage(statement): object[]

Defined in: models/lib/repositories/memory.d.ts:269

Keys of the stored objects of this model matching a statement's WHERE, at most LIMIT

Synchronous: the statement then runs without yielding, so no other write interleaves and an object is never met twice.

Parameters​

statement​

Query

the parsed statement

Returns​

object[]

the storage keys and their objects

Inherited from​

MemoryRepository.matchStorage

monitor()​

protected monitor<R>(operation, query, fn, details): Promise<R>

Defined in: models/lib/repositories/abstract.d.ts:247

Helper that times a query operation, catches and rethrows errors, and calls onQuery safely

Type Parameters​

R​

R

Parameters​

operation​

QueryOperation

the query operation

query​

string

the query string

fn​

() => Promise<R>

the async function to execute and time

details​

((r) => object) | ((r) => number)

optional callback to extract result count or pagination details

Returns​

Promise<R>

the result of fn

Inherited from​

MemoryRepository.monitor

off()​

off<K>(event, listener): void

Defined in: models/lib/repositories/abstract.d.ts:316

Type Parameters​

K​

K extends string | number | symbol

Parameters​

event​

K

listener​

(data) => void

Returns​

void

Inherited from​

MemoryRepository.off

on()​

on<K>(event, listener): void

Defined in: models/lib/repositories/abstract.d.ts:312

Type Parameters​

K​

K extends string | number | symbol

Parameters​

event​

K

listener​

(data) => void

Returns​

void

Inherited from​

MemoryRepository.on

once()​

once<K>(event, listener): void

Defined in: models/lib/repositories/abstract.d.ts:314

Type Parameters​

K​

K extends string | number | symbol

Parameters​

event​

K

listener​

(data) => void

Returns​

void

Inherited from​

MemoryRepository.once

parseLegacyUID()​

protected parseLegacyUID(uid): PrimaryKey<InstanceType<T>> | undefined

Defined in: models/lib/repositories/abstract.d.ts:108

Parse a uid through the model's parseLegacyUID hook

Parameters​

uid​

string

the raw storage key

Returns​

PrimaryKey<InstanceType<T>> | undefined

a key whose string form is the raw uid, or undefined when the model does not recognise it

Inherited from​

MemoryRepository.parseLegacyUID

parseStatement()​

protected parseStatement(type, statement, params?): Promise<Query>

Defined in: models/lib/repositories/abstract.d.ts:156

Parse a bulk statement and check it is of the expected type

For an UPDATE, every SET target is checked: no primary key field, no private (__) segment, no constructor/prototype segment, and a field of the model when its metadata lists them.

Parameters​

type​

"DELETE" | "UPDATE"

the expected statement type

statement​

string | Query

the statement string or its parsed form

params?​

QueryParameters

values for the placeholders of a statement string

Returns​

Promise<Query>

the parsed statement

Throws​

WebdaQLError when the statement has another type or a SET target is refused

Throws​

SyntaxError when the statement does not parse, or a SET target is not a field of the model

Inherited from​

MemoryRepository.parseStatement

parseUID()​

parseUID(uid, forceObject?): PrimaryKeyType<InstanceType<T>> | PrimaryKey<InstanceType<T>>

Defined in: models/lib/repositories/abstract.d.ts:102

Parse a serialized primary key

A composite key that does not split into the primary key fields is offered to the model's optional static parseLegacyUID(uid) hook (see WEBDA_LEGACY_UID): the returned key keeps the raw uid as its string form so it addresses the legacy storage entry. Without a hook, or when the hook declines, the uid is rejected.

Parameters​

uid​

string

forceObject?​

boolean

Returns​

PrimaryKeyType<InstanceType<T>> | PrimaryKey<InstanceType<T>>

Inherited from​

MemoryRepository.parseUID

patch()​

patch(primaryKey, data, conditionField?, condition?): Promise<void>

Defined in: sql/lib/repository.d.ts:185

Parameters​

primaryKey​

any

data​

any

conditionField?​

any

condition?​

any

Returns​

Promise<void>

Overrides​

MemoryRepository.patch

query()​

query(queryStr): Promise<{ continuationToken?: string; results: InstanceType<T>[]; }>

Defined in: sql/lib/repository.d.ts:205

— use SQL WHERE clause instead of in-memory scan

Parameters​

queryStr​

any

Returns​

Promise<{ continuationToken?: string; results: InstanceType<T>[]; }>

Overrides​

MemoryRepository.query

ref()​

ref(key): ModelRefWithCreate<InstanceType<T>>

Defined in: models/lib/repositories/abstract.d.ts:122

Parameters​

key​

PK<InstanceType<T>, InstanceType<T>[typeof WEBDA_PRIMARY_KEY][number]>

Returns​

ModelRefWithCreate<InstanceType<T>>

Inherited from​

MemoryRepository.ref

removeAttribute()​

removeAttribute(primaryKey, attribute, conditionField?, condition?): Promise<void>

Defined in: sql/lib/repository.d.ts:191

Parameters​

primaryKey​

any

attribute​

any

conditionField?​

any

condition?​

any

Returns​

Promise<void>

Overrides​

MemoryRepository.removeAttribute

removeListener()​

removeListener<K>(event, listener): void

Defined in: models/lib/repositories/abstract.d.ts:329

EventEmitter-compatibility alias for off. Consumers that treat a repository as a Node EventEmitter (e.g. @webda/runtime EventIterator) call removeListener.

Type Parameters​

K​

K extends string | number | symbol

Parameters​

event​

K

the event name

listener​

(data) => void

the listener to remove

Returns​

void

Inherited from​

MemoryRepository.removeListener

resolvePath()​

protected resolvePath(item, path): object

Defined in: models/lib/repositories/memory.d.ts:296

Resolve the parent object and last key of a dotted path, creating intermediate objects

Parameters​

item​

any

root object

path​

string

dotted path

Returns​

object

the holder and the last key

holder​

holder: any

key​

key: string

Inherited from​

MemoryRepository.resolvePath

rootAncestorTypes()​

protected rootAncestorTypes(): Record<string, string>

Defined in: sql/lib/repository.d.ts:123

Stored types naming a strict ancestor of the table model (e.g. CoreModel in a table of an application model): such rows belong to the table model, like unstamped rows

Returns​

Record<string, string>

the current identifier of the table model by lower-cased stored type, empty when this model does not own the table

safeOnQuery()​

protected safeOnQuery(info): void

Defined in: models/lib/repositories/abstract.d.ts:238

Safely invoke the onQuery callback without throwing into the caller

Parameters​

info​

QueryExecutionInfo

query execution info

Returns​

void

Inherited from​

MemoryRepository.safeOnQuery

serialize()​

serialize(item): string

Defined in: models/lib/repositories/memory.d.ts:97

Serialize the object to a string

This method is used to allow switching between different serialization methods

The serialized payload is also stamped with a top-level __type field carrying the concrete model identifier when available (item.constructor.Metadata?.Identifier). This lets query() and external storage backends filter results by class without re-instantiating every item — important when a single underlying storage map is shared across a model and its subclasses (the common case in production where each registered model owns its own MemoryRepository pointing at the same Map).

The stamp lives on the serializer envelope (sibling of value / $serializer), not inside value. deserialize() re-surfaces it on the reconstructed instance as a non-enumerable __type property so WebdaQL's filter eval can read it without it ever leaking into JSON.stringify or Object.keys output — keeping API responses and re-serialize cycles byte-identical for the model's own fields.

Models that don't carry Metadata (plain unit-test classes that don't go through Application.setModelMetadata) simply skip the stamp; the resulting payload is byte-identical to the previous implementation.

Parameters​

item​

InstanceType<T>

to serialize

Returns​

string

serialized object

Inherited from​

MemoryRepository.serialize

setAttribute()​

setAttribute<K, L>(primaryKey, attribute, value, conditionField?, condition?): Promise<void>

Defined in: models/lib/repositories/abstract.d.ts:120

Type Parameters​

K​

K extends string

L​

L extends string

Parameters​

primaryKey​

string | PK<InstanceType<T>, InstanceType<T>[typeof WEBDA_PRIMARY_KEY][number]>

attribute​

K

value​

_PropertyPathType<InstanceType<T>, K>

conditionField?​

L | null

condition?​

_PropertyPathType<InstanceType<T>, L> | JSONed<_PropertyPathType<InstanceType<T>, L>>

Returns​

Promise<void>

Inherited from​

MemoryRepository.setAttribute

setMaxListeners()​

setMaxListeners(n): this

Defined in: models/lib/repositories/abstract.d.ts:340

EventEmitter-compatibility shim. Records the max-listeners hint (no enforcement).

Parameters​

n​

number

the new hint value

Returns​

this

this for chaining

Inherited from​

MemoryRepository.setMaxListeners

setTableRoot()​

setTableRoot(root?): this

Defined in: models/lib/repositories/abstract.d.ts:53

Set the model owning the untyped rows of the storage

Parameters​

root?​

ModelClass<Storable<any, any>>

the first model of the store, undefined when not known

Returns​

this

this

Inherited from​

MemoryRepository.setTableRoot

setupTable()​

setupTable(): Promise<void>

Defined in: sql/lib/repository.d.ts:75

Internal

Ensure the backing table for this repository's model exists. Owns the per-model DDL of the store. Not part of the @webda/models Repository interface.

Returns​

Promise<void>

sqlQuery()​

protected sqlQuery(q, values?): Promise<{ rowCount: number; rows: any[]; }>

Defined in: sql/lib/repository.d.ts:168

Run a raw SQL query and return typed results.

Parameters​

q​

string

the SQL query (WHERE clause or full query)

values?​

any[]

the query parameters

Returns​

Promise<{ rowCount: number; rows: any[]; }>

the raw query result

tableModelClass()​

protected tableModelClass(): any

Defined in: sql/lib/repository.d.ts:116

The class of the table model, when it is this model or one of its subclasses

Returns​

any

the class, undefined when the table model is unknown or outside the model family

toStoredJSON()​

protected toStoredJSON(item, fallbackType?): string

Defined in: sql/lib/repository.d.ts:150

The JSON stored for an object: its fields, and its declared type in __type (see declaredType)

Parameters​

item​

any

the object

fallbackType?​

string

the type to stamp when the object declares none

Returns​

string

the JSON text

typeResolver()​

protected typeResolver(): ModelTypeResolver

Defined in: models/lib/repositories/abstract.d.ts:63

Resolver of the stored __type: the installed application one when it knows the model, else the model's own hierarchy with exact identifiers only

Returns​

ModelTypeResolver

the resolver

Inherited from​

MemoryRepository.typeResolver

update()​

update(data, conditionField?, condition?): Promise<void>

Defined in: sql/lib/repository.d.ts:183

Parameters​

data​

any

conditionField?​

any

condition?​

any

Returns​

Promise<void>

Overrides​

MemoryRepository.update

updateMany()​

updateMany(statement, params?): Promise<number>

Defined in: sql/lib/repository.d.ts:268

Update in bulk with one UPDATE ... SET data = <assignments> WHERE: no per-object event (see Repository.updateMany)

SET paths and values are bound parameters (the statement went through the grammar, see parseStatement); the parents of a dotted target are created when missing, an existing array parent is indexed.

Parameters​

statement​

string | Query

params?​

QueryParameters

Returns​

Promise<number>

Overrides​

MemoryRepository.updateMany

updateManyByKey()​

protected updateManyByKey(statement, params?): Promise<number>

Defined in: models/lib/repositories/abstract.d.ts:201

Generic updateMany: collect the matching keys (up to LIMIT), then patch them one by one with this repository's patch primitive. A dotted target reads the object to rewrite its top-level field.

Used by stores without a native bulk update. On a store repository the primitive emits no event.

Parameters​

statement​

string | Query

the UPDATE statement or its parsed form

params?​

QueryParameters

values for the placeholders

Returns​

Promise<number>

the number of objects updated

Inherited from​

MemoryRepository.updateManyByKey

upsert()​

upsert(data): Promise<InstanceType<T>>

Defined in: models/lib/repositories/abstract.d.ts:118

Parameters​

data​

Helpers<InstanceType<T>>

Returns​

Promise<InstanceType<T>>

Inherited from​

MemoryRepository.upsert

upsertItemToCollection()​

upsertItemToCollection(primaryKey, collection, item, index?, itemWriteConditionField?, itemWriteCondition?): Promise<void>

Defined in: sql/lib/repository.d.ts:195

Parameters​

primaryKey​

any

collection​

any

item​

any

index?​

number

itemWriteConditionField?​

any

itemWriteCondition?​

any

Returns​

Promise<void>

Overrides​

MemoryRepository.upsertItemToCollection

writeIfPresent()​

protected writeIfPresent(key, write): Promise<boolean>

Defined in: models/lib/repositories/abstract.d.ts:181

Run one write of the generic fallback; an object deleted since the keys were collected is skipped

Parameters​

key​

PrimaryKeyType<InstanceType<T>>

the primary key

write​

() => Promise<void>

the write

Returns​

Promise<boolean>

true when written, false when the object is gone

Throws​

the write error when the object still exists

Inherited from​

MemoryRepository.writeIfPresent

rootIdentifier()​

static rootIdentifier(model): string | undefined

Defined in: sql/lib/repository.d.ts:54

Parameters​

model​

any

a model class

Returns​

string | undefined

the identifier of its topmost ancestor (itself included) carrying metadata

simulateFind()​

static simulateFind<T>(query, uuids, repository): Promise<{ continuationToken?: string; results: InstanceType<T>[]; }>

Defined in: models/lib/repositories/memory.d.ts:239

Allow to simulate a find on a list of uuids It is static to be reusable by other repository like FileRepository

Type Parameters​

T​

T extends ModelClass<Storable<any, any>>

Parameters​

query​

Query

the parsed query

uuids​

any[]

the list of UIDs to search

repository​

Repository<T>

the repository to fetch objects from

Returns​

Promise<{ continuationToken?: string; results: InstanceType<T>[]; }>

the query results with optional continuation token

Inherited from​

MemoryRepository.simulateFind