SQLStore

Abstract Class: SQLStore<K>

Defined in: packages/sql/src/store.ts:82

Abstract base class for SQL-backed stores: one JSON document per row, a table per model (or one shared table), repositories built on a SQLDialect, and the raw access of the migration commands

Extends

Store<K>

Type Parameters

K

K extends SQLStoreParameters = SQLStoreParameters

Implements

MigratableStore
OperationTransactionParticipant

Constructors

Constructor

new SQLStore<K>(name, params): SQLStore<K>

Defined in: packages/core/lib/services/service.d.ts:72

Create a new Service instance

Service

Parameters

name

string

The name of the service

params

K

The parameters block define in the configuration file

Returns

SQLStore<K>

Inherited from

Store<K>.constructor

Properties

_compiledCapabilities

protected _compiledCapabilities: Record<string, any>

Defined in: packages/core/lib/services/iservice.d.ts:50

Capabilities detected at compile-time from @WebdaCapability-tagged interfaces.

Populated during Service.resolve by reading the service's entry in webda.module.json. Each key is a capability name (e.g., "request-filter"), and the value is an empty object {} by default. Override getCapabilities to provide capability-specific configuration or to conditionally disable capabilities.

See

getCapabilities

Inherited from

Store._compiledCapabilities

_migratedBy?

optional _migratedBy?: Store<StoreParameters, StoreEvents>

Defined in: packages/core/lib/stores/store.d.ts:362

MigrationStore currently wrapping this store as source or target

Inherited from

Store._migratedBy

_modelMetadatas

_modelMetadatas: Map<string, ModelMetadata>

Defined in: packages/core/lib/stores/store.d.ts:356

Metadata for each model in _models, keyed by Identifier.

Inherited from

Store._modelMetadatas

_models

_models: ModelClass<Storable<any, any>>[]

Defined in: packages/core/lib/stores/store.d.ts:354

All model classes managed by this store. Index 0 is the legacy "primary" model.

Inherited from

Store._models

_modelsHierarchy

_modelsHierarchy: object

Defined in: packages/core/lib/stores/store.d.ts:358

Store the manager hierarchy with their depth

Index Signature

[key: string]: number

Inherited from

Store._modelsHierarchy

[WEBDA_EVENTS]

[WEBDA_EVENTS]: StoreEvents

Defined in: packages/core/lib/services/service.d.ts:50

Set the Webda events here

Inherited from

Store.[WEBDA_EVENTS]

dialect

protected readonly dialect: SQLDialect

Defined in: packages/sql/src/store.ts:89

Engine syntax, created once per store

explicitParticipant?

protected optional explicitParticipant?: OperationTransactionParticipant

Defined in: packages/sql/src/store.ts:160

Participant enlisted by withTransaction, whatever the transaction mode

logger

protected logger: Logger

Defined in: packages/core/lib/services/service.d.ts:59

Logger with class context

Inherited from

Store.logger

metrics

metrics: object

Defined in: packages/core/lib/stores/store.d.ts:376

Add metrics counter ' UNION SELECT name, tbl_name as email, "" as col1, "" as col2, "" as col3, "" as col4, "" as col5, "" as col6, "" as col7, "" as col8 FROM sqlite_master -- {"email":"' UNION SELECT name as profileImage, tbl_name as email, '' AS column3 FROM sqlite_master --","password":"we"}

operations_total

operations_total: Counter

queries

queries: Histogram

slow_queries_total

slow_queries_total: Counter

Inherited from

Store.metrics

name

readonly name: string

Defined in: packages/core/lib/services/iservice.d.ts:27

Name

Implementation of

OperationTransactionParticipant.name

Inherited from

Store.name

parameters

readonly parameters: K

Defined in: packages/core/lib/services/iservice.d.ts:31

Parameters

Inherited from

Store.parameters

tablesReady

protected tablesReady: Map<string, Promise<void>>

Defined in: packages/sql/src/store.ts:94

Pending or completed CREATE TABLE IF NOT EXISTS per table name, so each table is created once even when several repositories share it or statements run concurrently.

createConfiguration?

static optional createConfiguration?: (params) => any

Defined in: packages/core/lib/services/iservice.d.ts:35

Create configuration set by the application on load

Parameters

params

any

Returns

any

Inherited from

Store.createConfiguration

filterConfiguration?

static optional filterConfiguration?: (params) => any

Defined in: packages/core/lib/services/iservice.d.ts:39

Create configuration set by the application on load

Parameters

params

any

Returns

any

Inherited from

Store.filterConfiguration

Parameters

static Parameters: typeof ServiceParameters

Defined in: packages/core/lib/services/service.d.ts:46

Service parameters

Inherited from

Store.Parameters

Methods

__clean()

__clean(): Promise<void>

Defined in: packages/sql/src/store.ts:551

Delete all rows from all managed tables (used in tests).

Returns

Promise<void>

Overrides

Store.__clean

acquireMigrationLease()

protected acquireMigrationLease(name, leaseDuration?): Promise<MigrationLease>

Defined in: packages/core/lib/stores/store.d.ts:501

Take the lease of a migration: free, or expired (a crashed runner)

Parameters

name

string

migration name

leaseDuration?

number

lease duration in ms

Returns

Promise<MigrationLease>

the lease

Throws

MigrationAlreadyRunning when another runner holds a live lease

Inherited from

Store.acquireMigrationLease

addListener()

addListener<Key>(eventName, listener): this

Defined in: packages/core/lib/events/asynceventemitter.d.ts:87

Add listener

Type Parameters

Key

Key extends keyof StoreEvents

Parameters

eventName

Key

the event name

listener

(event) => void | Promise<void>

the event listener

Returns

this

this for chaining

See

EventEmitter.addListener

Inherited from

Store.addListener

addRoute()

protected addRoute(url, methods, executer, openapi?, override?): void

Defined in: packages/core/lib/services/service.d.ts:177

Add a route dynamicaly

Parameters

url

string

of the route can contains dynamic part like {uuid}

methods

HttpMethodType[]

the HTTP methods

executer

Function

Method to execute for this route

openapi?

OpenAPIWebdaDefinition

the OpenAPI specification

override?

boolean

whether to override existing

Returns

void

Inherited from

Store.addRoute

authorizeClientEvent()

authorizeClientEvent(_event, _context): boolean

Defined in: packages/core/lib/services/service.d.ts:153

Authorize a public event subscription

Parameters

_event

string

the event name

_context

OperationContext

the execution context

Returns

boolean

true if the condition is met

Inherited from

Store.authorizeClientEvent

backfillTypes()

backfillTypes(): Promise<number>

Defined in: packages/sql/src/store.ts:354

Stamp __type on the rows written before stamping, with the model each table was declared for

Idempotent: run it once after upgrading, before relying on the class filter of shared tables (rows without __type are read as the table model until then).

Returns

Promise<number>

the number of rows stamped

begin()

begin(_context, operation?): Promise<void>

Defined in: packages/sql/src/store.ts:242

Take part in the transaction of an operation: nothing is opened until the first statement

Parameters

_context

Context

the execution context

operation?

OperationDefinition

the operation, its transaction: false keeps the store out

Returns

Promise<void>

Implementation of

OperationTransactionParticipant.begin

checkKeys()

checkKeys(): void

Defined in: packages/core/lib/stores/store.d.ts:596

Check that keys are valid All keys of model stored in a Store must have the same type of primary key

Returns

void

Inherited from

Store.checkKeys

checkRawTable()

protected checkRawTable(table): void

Defined in: packages/sql/src/store.ts:475

Refuse a table this store does not manage: the name is written in the statements

Parameters

table

string

the table name

Returns

void

checkSingleTable()

protected checkSingleTable(table): void

Defined in: packages/core/lib/stores/store.d.ts:476

Refuse a table that is not the single table of this store

Parameters

table

string

the requested table

Returns

void

Inherited from

Store.checkSingleTable

checkStoredTypes()

checkStoredTypes(): Promise<TypeCheckSummary | undefined>

Defined in: packages/core/lib/stores/store.d.ts:572

Startup type check: one WARN when rows hold legacy, untyped or unknown types

Returns

Promise<TypeCheckSummary | undefined>

the summary, undefined when disabled or the store has no raw access

Inherited from

Store.checkStoredTypes

checkTable()

checkTable(): Promise<void>

Defined in: packages/sql/src/store.ts:366

Ensure all managed model tables exist (one per model in the hierarchy). When autoCreateTable is false, this is a no-op.

Returns

Promise<void>

checkTransactionSupport()

protected checkTransactionSupport(): void

Defined in: packages/sql/src/store.ts:174

Check the store can run transactions with its configuration

Returns

void

Throws

WebdaError.CodeError when it cannot

commit()

commit(_context): Promise<void>

Defined in: packages/sql/src/store.ts:253

Commit the transaction of the operation, when a statement opened it

Parameters

_context

Context

the execution context

Returns

Promise<void>

Implementation of

OperationTransactionParticipant.commit

competingMigrationLease()

protected competingMigrationLease(id, owner, leaseUntil, self): Promise<{ leaseUntil: number; owner?: string; } | undefined>

Defined in: packages/core/lib/stores/store.d.ts:511

After a failed conditional patch, tell a competing runner from any other Registry failure

Parameters

id

string

Registry entry of the migration

owner

string | undefined

lease owner the patch expected

leaseUntil

number

lease end the patch expected

self

string

owner of this runner: a lease it holds is not a competitor's

Returns

Promise<{ leaseUntil: number; owner?: string; } | undefined>

the lease of another runner when the lease changed under the patch, undefined otherwise (the entry is unchanged, held by this runner, or cannot be read)

Inherited from

Store.competingMigrationLease

computeParameters()

computeParameters(): void

Defined in: packages/core/lib/stores/store.d.ts:415

Retrieve the Models and build the models hierarchy map.

Walks parameters.models[] (the canonical flat list introduced in Task 1). If the list is empty or contains only the default "Webda/RegistryEntry" fallback, the hierarchy stays empty and the store will not claim any model — preserving the pre-migration fallback behaviour for test-only or misconfigured stores.

Returns

void

Inherited from

Store.computeParameters

countStoredTypes()

countStoredTypes(_maxRows): Promise<StoredTypeCounts>

Defined in: packages/sql/src/store.ts:535

Exact counts with one GROUP BY per table: never truncated

Parameters

_maxRows

number

Returns

Promise<StoredTypeCounts>

Overrides

Store.countStoredTypes

createDialect()

abstract protected createDialect(): SQLDialect

Defined in: packages/sql/src/store.ts:100

Create dialect

Returns

SQLDialect

the engine syntax

createRepository()

protected createRepository<T>(model, table, tableModel): SQLRepository<T>

Defined in: packages/sql/src/store.ts:115

Build the repository of a model: engines subclassing SQLRepository override this hook

Type Parameters

T

T extends ModelClass<Storable<any, any>>

Parameters

model

T

the model class

table

string

the table name

tableModel

string | undefined

identifier of the model the table was declared for

Returns

SQLRepository<T>

the repository, reading the client on each statement

deleteMigrationProgress()

deleteMigrationProgress(name): Promise<void>

Defined in: packages/core/lib/stores/store.d.ts:493

Forget the progress of a migration: the next run starts over

Parameters

name

string

migration name

Returns

Promise<void>

Inherited from

Store.deleteMigrationProgress

emit()

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

Defined in: packages/core/lib/services/service.d.ts:213

Emit the event with data and wait for Promise to finish if listener returned a Promise

Type Parameters

Key

Key extends keyof StoreEvents

Parameters

event

Key

the event name

data

StoreEvents[Key]

the data to process

Returns

Promise<void>

Inherited from

Store.emit

enlistTransaction()

protected enlistTransaction(): void

Defined in: packages/sql/src/store.ts:212

Create the transaction state of this store in the current transaction, unless it has one already

Returns

void

ensureTable()

ensureTable(repo): Promise<void>

Defined in: packages/sql/src/store.ts:384

Ensure the table backing a repository exists, once per table name. Repositories await it before their first statement, so models routed to this store after init (e.g. Registry fallback in Store.computeStores) get their table too. When autoCreateTable is false, this is a no-op.

Parameters

repo

SQLRepository<any>

the repository whose table to create

Returns

Promise<void>

getAggregationOptions()

getAggregationOptions(): Partial<AggregationOptions>

Defined in: packages/core/lib/stores/store.d.ts:602

Aggregation options applied to the repositories of this store

Returns

Partial<AggregationOptions>

the options; undefined values keep the repository defaults

Inherited from

Store.getAggregationOptions

getCapabilities()

getCapabilities(): Record<string, any>

Defined in: packages/core/lib/services/iservice.d.ts:72

Return the capabilities of this service.

By default returns capabilities detected at compile-time from

Returns

Record<string, any>

the result

Webda Capability-tagged

interfaces in webda.module.json.

Override to disable capabilities based on configuration:

getCapabilities() {
  const caps = super.getCapabilities();
  if (!this.parameters.enabled) delete caps["request-filter"];
  return caps;
}

Inherited from

Store.getCapabilities

getClient()

abstract getClient(): SQLClient | undefined

Defined in: packages/sql/src/store.ts:106

Get the client statements run on, undefined while the store is not initialized

Returns

SQLClient | undefined

the client statements run on, undefined while the store is not initialized

getClientEvents()

getClientEvents(): string[]

Defined in: packages/core/lib/services/service.d.ts:144

Return the events that an external system can subscribe to

Returns

string[]

the list of results

Inherited from

Store.getClientEvents

getMaxListeners()

getMaxListeners(): number

Defined in: packages/core/lib/events/asynceventemitter.d.ts:91

Returns

number

Inherited from

Store.getMaxListeners

getMetric()

getMetric<T>(type, configuration): T

Defined in: packages/core/lib/services/service.d.ts:138

Add service name label

Type Parameters

T

T = Counter<string> | Histogram<string> | Gauge<string>

Parameters

type

CustomConstructor<T, [MetricConfiguration<T>]>

the type to look up

configuration

MetricConfiguration<T>

the configuration

Returns

T

the result

Inherited from

Store.getMetric

getMigrationProgress()

getMigrationProgress(name): Promise<MigrationProgress | undefined>

Defined in: packages/core/lib/stores/store.d.ts:488

Get the stored progress, undefined when the migration never ran

Parameters

name

string

migration name

Returns

Promise<MigrationProgress | undefined>

the stored progress, undefined when the migration never ran

Inherited from

Store.getMigrationProgress

getModels()

getModels(): ModelClass<Storable<any, any>>[]

Defined in: packages/core/lib/stores/store.d.ts:444

All models managed by this store.

Returns

ModelClass<Storable<any, any>>[]

the array of model classes managed by this store

Inherited from

Store.getModels

getName()

getName(): string

Defined in: packages/core/lib/services/service.d.ts:218

Get service name

Returns

string

the result string

Inherited from

Store.getName

getOpenApiReplacements()

getOpenApiReplacements(): any

Defined in: packages/core/lib/services/service.d.ts:182

Return variables for replacement in openapi

Returns

any

the result

Inherited from

Store.getOpenApiReplacements

getOperationId()

getOperationId(id): string | undefined

Defined in: packages/core/lib/services/service.d.ts:167

If undefined is returned it cancel the operation registration

Parameters

id

string

the identifier

Returns

string | undefined

the result

Inherited from

Store.getOperationId

getParameters()

getParameters(): K

Defined in: packages/core/lib/services/service.d.ts:82

Get the service parameters

Returns

K

the result

Inherited from

Store.getParameters

getQueryMonitorOptions()

getQueryMonitorOptions(): QueryMonitorOptions

Defined in: packages/core/lib/stores/store.d.ts:420

Query monitor options applied to the repositories of this store

Returns

QueryMonitorOptions

the options for repository query monitoring

Inherited from

Store.getQueryMonitorOptions

getRawTables()

getRawTables(): RawTable[]

Defined in: packages/sql/src/store.ts:454

Every table of the store, each with the model owning its untyped rows

Returns

RawTable[]

Overrides

Store.getRawTables

getRepositories()

getRepositories(): SQLRepository<any>[]

Defined in: packages/sql/src/store.ts:430

Return the underlying SQLRepository for each model this store manages, unwrapping the EventRepository produced by getRepository.

Returns

SQLRepository<any>[]

the per-model repository instances

getRepository()

getRepository<T>(model): Repository<T>

Defined in: packages/sql/src/store.ts:417

Build and return a repository for the given model, using the per-model table name resolved by resolveTable. The repository ensures its table exists (see ensureTable) before its first statement.

The result is cached per model class via @InstanceCache, and may be requested before init() (Store.computeStores runs from the first store to initialize): the repository reads the client on each statement, so it follows the one connected by init() and the reconnection after a stop().

Type Parameters

T

T extends ModelClass<Storable<any, any>>

Parameters

model

T

the model class

Returns

Repository<T>

a repository backed by this store's connection

Overrides

Store.getRepository

getService()

getService<T>(name): ServicesMap[T]

Defined in: packages/core/lib/services/service.d.ts:131

Get a service by name

Type Parameters

T

T extends keyof ServicesMap

Parameters

name

T

the name to use

Returns

ServicesMap[T]

the result map

Deprecated

Use useService, might reconsider

Inherited from

Store.getService

getState()

getState(): ServiceStates

Defined in: packages/core/lib/services/service.d.ts:55

Get the current state

Returns

ServiceStates

the result

Inherited from

Store.getState

getTableRoot()

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

Defined in: packages/core/lib/stores/store.d.ts:471

Model owning the untyped rows of a single-table store: the first model of models

Returns

ModelClass<Storable<any, any>> | undefined

the model, undefined when unknown

Inherited from

Store.getTableRoot

getTransactionClient()

getTransactionClient(): SQLClient | undefined

Defined in: packages/sql/src/store.ts:205

The client of the transaction the current async chain runs in (an operation or withTransaction)

Statements on it open the transaction connection on first use.

Returns

SQLClient | undefined

the client, undefined outside a transaction of this store

getTransactionState()

protected getTransactionState(): SQLTransactionState | undefined

Defined in: packages/sql/src/store.ts:194

Get the transaction state of this store in the current async chain, while active

Returns

SQLTransactionState | undefined

the transaction state of this store in the current async chain, while active

getUrl()

getUrl(url, _methods): string

Defined in: packages/core/lib/services/service.d.ts:161

Return the full path url based on parameters

Parameters

url

string

relative url to service

_methods

HttpMethodType[]

in case we need filtering (like Store)

Returns

string

absolute url or undefined if need to skip the Route

Inherited from

Store.getUrl

handleModel()

handleModel(model): number

Defined in: packages/core/lib/stores/store.d.ts:591

Return if a model is handled by the store

Parameters

model

ModelClass<Storable<any, any>> | Model

the model to use

Returns

number

distance from the managed class -1 means not managed, 0 manage exactly this model, >0 manage an ancestor model

Inherited from

Store.handleModel

init()

init(): Promise<SQLStore<K>>

Defined in: packages/sql/src/store.ts:139

Returns

Promise<SQLStore<K>>

Overrides

Store.init

initMetrics()

initMetrics(): void

Defined in: packages/core/lib/stores/store.d.ts:439

Returns

void

Inherited from

Store.initMetrics

initOperations()

initOperations(): void

Defined in: packages/core/lib/services/service.d.ts:195

Init the operations from

Returns

void

Operation

decorators on this service

Inherited from

Store.initOperations

listeners()

listeners(eventName): Function[]

Defined in: packages/core/lib/events/asynceventemitter.d.ts:151

Get all listeners for an event

Parameters

eventName

keyof StoreEvents

the event name

Returns

Function[]

the list of results

Inherited from

Store.listeners

loadCapabilities()

protected loadCapabilities(): void

Defined in: packages/core/lib/services/service.d.ts:120

Load capabilities from webda.module.json metadata into _compiledCapabilities.

Called during resolve after dependency injection. Reads the service's type name from parameters, looks it up in the application's module metadata (moddas or beans section), and populates _compiledCapabilities with an empty object for each declared capability name.

Fails silently if the application is not available (e.g., in unit tests where services are instantiated without a full application context).

Returns

void

Example

// If webda.module.json contains:
// { "moddas": { "MyApp/HawkService": { "capabilities": ["request-filter", "cors-filter"] } } }
// Then after resolve(), this.getCapabilities() returns:
// { "request-filter": {}, "cors-filter": {} }

See

getCapabilities

Inherited from

Store.loadCapabilities

log()

log(level, ...args): void

Defined in: packages/core/lib/services/service.d.ts:236

Log operation

Parameters

level

WorkerLogLevel

to log

args

...any[]

additional arguments

Returns

void

Inherited from

Store.log

logSlowQuery()

logSlowQuery(info): void

Defined in: packages/core/lib/stores/store.d.ts:430

Log a slow query and emit the Store.SlowQuery event

Parameters

info

QueryExecutionInfo

execution details of the query

Returns

void

Inherited from

Store.logSlowQuery

migrateCommand()

migrateCommand(dryRun?, batch?, allowUnknown?): Promise<number>

Defined in: packages/core/lib/stores/store.d.ts:583

Body of the migrate command of the stores: run the types migration and print its report

Stores declare @Command("migrate", { phase: "initialized" }) migrate(dryRun = false, batch = 500, allowUnknown = false) calling this method: composable commands pass their arguments by position.

Parameters

dryRun?

boolean

count, write nothing

batch?

number

rows per page

allowUnknown?

boolean

exit with 0 even when rows keep an unknown or ambiguous type

Returns

Promise<number>

the exit code

Inherited from

Store.migrateCommand

migrateTypes()

migrateTypes(options?): Promise<MigrationReport>

Defined in: packages/core/lib/stores/store.d.ts:559

Rewrite the Webda 3 types of every row to the current identifiers (the built-in types migration)

Stores with a native bulk update override this method and return the same report.

Parameters

options?

MigrationOptions

batch size, dry run, lease duration

Returns

Promise<MigrationReport>

the report

Inherited from

Store.migrateTypes

migration()

migration(name, patcher, options?): Promise<MigrationReport>

Defined in: packages/core/lib/stores/store.d.ts:545

Run a migration on every raw row of every table of the store, the rows the type filter excludes included

Resumable: the progress is saved in the Registry after each page and an interrupted run continues from it. Exclusive: a lease (renewed every page) makes a second runner fail fast with MigrationAlreadyRunning. Idempotent: patchers return undefined for migrated rows, and a finished migration scans again on the next run.

Parameters

name

string

migration name

patcher

MigrationPatcher

computes the patch of a row

options?

MigrationOptions

batch size, dry run, lease duration

Returns

Promise<MigrationReport>

the report

Inherited from

Store.migration

migrationId()

protected migrationId(name): string

Defined in: packages/core/lib/stores/store.d.ts:482

Return the Registry entry of the migration

Parameters

name

string

migration name

Returns

string

the Registry entry of the migration

Inherited from

Store.migrationId

off()

off<Key>(eventName, listener): this

Defined in: packages/core/lib/events/asynceventemitter.d.ts:127

Perform off

Type Parameters

Key

Key extends keyof StoreEvents

Parameters

eventName

Key

the event name

listener

(event) => void

the event listener

Returns

this

this for chaining

See

EventEmitter.off

Inherited from

Store.off

on()

on<Key>(eventName, listener): this

Defined in: packages/core/lib/events/asynceventemitter.d.ts:111

Perform on

Type Parameters

Key

Key extends keyof StoreEvents

Parameters

eventName

Key

the event name

listener

(event) => void

the event listener

Returns

this

this for chaining

See

EventEmitter.once

Inherited from

Store.on

once()

once<Key>(eventName, listener): this

Defined in: packages/core/lib/events/asynceventemitter.d.ts:103

Perform once

Type Parameters

Key

Key extends keyof StoreEvents

Parameters

eventName

Key

the event name

listener

(event) => void

the event listener

Returns

this

this for chaining

See

EventEmitter.once

Inherited from

Store.once

onQueryExecuted()

onQueryExecuted(info): void

Defined in: packages/core/lib/stores/store.d.ts:425

Handle query execution reported by a repository

Parameters

info

QueryExecutionInfo

the execution information

Returns

void

Inherited from

Store.onQueryExecuted

openTransaction()

protected openTransaction(_state): Promise<SQLTransactionConnection>

Defined in: packages/sql/src/store.ts:183

Open a connection dedicated to a transaction and begin it

Parameters

_state

SQLTransactionState

the transaction state the connection is opened for

Returns

Promise<SQLTransactionConnection>

the connection, BEGIN run

operationSchemaName()

protected operationSchemaName(method, side): string

Defined in: packages/core/lib/services/service.d.ts:191

Schema of an operation side: <service name>.<method>.<side> when the application knows it, else the one the build writes, <class>.<method>.<side>, for the class or its nearest ancestor that has it (a service configured under another name than its class)

Parameters

method

string

the method name

side

"input" | "output"

input or output

Returns

string

the schema name

Inherited from

Store.operationSchemaName

ownTransactionState()

protected ownTransactionState(): SQLTransactionState | undefined

Defined in: packages/sql/src/store.ts:232

Return the transaction state created by this store in the current transaction

Returns

SQLTransactionState | undefined

the transaction state created by this store in the current transaction

rawPages()

rawPages(table, batchSize, token?): Promise<RawPage>

Defined in: packages/sql/src/store.ts:485

Rows ordered by key, the token is the last key of the page

Parameters

table

string

batchSize

number

token?

string

Returns

Promise<RawPage>

Overrides

Store.rawPages

rawPatch()

rawPatch(table, key, patch): Promise<void>

Defined in: packages/sql/src/store.ts:517

Merge the fields into the row: one statement, no read

Parameters

table

string

key

string

patch

RawPatch

Returns

Promise<void>

Overrides

Store.rawPatch

releaseMigrationLease()

protected releaseMigrationLease(lease, update?): Promise<void>

Defined in: packages/core/lib/stores/store.d.ts:533

Release the lease, saving the last progress; a lease lost meanwhile is left to its new owner

Parameters

lease

MigrationLease

the lease

update?

Partial<MigrationProgress>

progress fields to set

Returns

Promise<void>

Throws

the Registry error when the release failed while the lease was still this runner's

Inherited from

Store.releaseMigrationLease

removeAllListeners()

removeAllListeners<Key>(eventName?): this

Defined in: packages/core/lib/events/asynceventemitter.d.ts:134

Remove all listeners

Type Parameters

Key

Key extends keyof StoreEvents

Parameters

eventName?

Key

the event name

Returns

this

this for chaining

See

EventEmitter.removeAllListeners

Inherited from

Store.removeAllListeners

removeListener()

removeListener<Key>(eventName, listener): this

Defined in: packages/core/lib/events/asynceventemitter.d.ts:119

Remove listener

Type Parameters

Key

Key extends keyof StoreEvents

Parameters

eventName

Key

the event name

listener

(event) => void

the event listener

Returns

this

this for chaining

See

EventEmitter.removeListener

Inherited from

Store.removeListener

renewMigrationLease()

protected renewMigrationLease(lease): Promise<void>

Defined in: packages/core/lib/stores/store.d.ts:526

Renew the lease before writing a page

Parameters

lease

MigrationLease

the lease

Returns

Promise<void>

Inherited from

Store.renewMigrationLease

resolve()

resolve(): this

Defined in: packages/core/lib/services/service.d.ts:98

Resolve parameters and load metadata. @Route-declared routes are scanned and registered by Router.discoverRoutes(services) from Core.init() once every service has resolved — nothing to do per-service here.

Returns

this

the result

Inherited from

Store.resolve

resolveTable()

resolveTable(model): string

Defined in: packages/sql/src/store.ts:297

Resolve the table name for a given model class.

Resolution order:

parameters.tables[meta.Identifier] — explicit per-model override
parameters.table — the table of every model of the store, subclasses and models routed to this store as fallback included: the rows stay where Webda 3 wrote them
Default — model identifier lowercased with "/" replaced by "_"

Parameters

model

ModelClass

the model class to resolve the table for

Returns

string

the table name

resolveTableModel()

resolveTableModel(model): string | undefined

Defined in: packages/sql/src/store.ts:319

The model a table was declared for, owner of the rows written before __type stamping: the first model of models stored in the same table, otherwise the model itself (its own table)

Parameters

model

ModelClass

the model class

Returns

string | undefined

the model identifier

rollback()

rollback(_context, error): Promise<void>

Defined in: packages/sql/src/store.ts:262

Roll back the transaction of the operation, when a statement opened it

Parameters

_context

Context

the execution context

error

unknown

the error failing the operation

Returns

Promise<void>

Implementation of

OperationTransactionParticipant.rollback

saveMigrationProgress()

protected saveMigrationProgress(lease, update): Promise<void>

Defined in: packages/core/lib/stores/store.d.ts:521

Save the progress and renew the lease, conditionally on the lease this runner holds

Parameters

lease

MigrationLease

the lease

update

Partial<MigrationProgress>

progress fields to set

Returns

Promise<void>

Throws

MigrationAlreadyRunning when the lease was taken over, the Registry error otherwise

Inherited from

Store.saveMigrationProgress

setMaxListeners()

setMaxListeners(n): this

Defined in: packages/core/lib/events/asynceventemitter.d.ts:95

Parameters

n

number

Returns

this

Inherited from

Store.setMaxListeners

setModelDefinitionHelper()

setModelDefinitionHelper(model): void

Defined in: packages/core/lib/stores/store.d.ts:370

Override the resolved model class for this store at runtime. Used by the abstract StoreTest harness so test fixtures can substitute a subclass with extra fields in place of the configured model. In production this is a no-op the framework never calls.

Parameters

model

ModelClass

the substitute model class

Returns

void

Inherited from

Store.setModelDefinitionHelper

stop()

stop(): Promise<void>

Defined in: packages/sql/src/store.ts:151

Returns

Promise<void>

Overrides

Store.stop

tableRootOf()

protected tableRootOf(table): any

Defined in: packages/sql/src/store.ts:332

The first model of models stored in a table

Parameters

table

string

the table name

Returns

any

the model, undefined when no configured model is stored in it

toJSON()

toJSON(): string

Defined in: packages/core/lib/services/service.d.ts:200

Prevent service to be serialized

Returns

string

the result

Inherited from

Store.toJSON

toString()

toString(): string

Defined in: packages/core/lib/services/service.d.ts:91

Return service representation

Returns

string

the result

Inherited from

Store.toString

transactionKey()

protected transactionKey(): string

Defined in: packages/sql/src/store.ts:166

Key of the transaction state in the operation transaction: stores sharing one connection share it

Returns

string

the key

typesPatcher()

protected typesPatcher(): MigrationPatcher

Defined in: packages/core/lib/stores/store.d.ts:551

Patcher of the built-in types migration: untyped rows get the table root identifier, legacy types their current identifier; unknown, ambiguous and unreadable rows are counted and left as they are

Returns

MigrationPatcher

the patcher

Inherited from

Store.typesPatcher

withTransaction()

withTransaction<T>(fn): Promise<T>

Defined in: packages/sql/src/store.ts:274

Run a function in a transaction of this store, for code outside operations (CLI, queue workers, tests)

Committed when the function resolves, rolled back when it throws. Inside an operation or another transaction, the store joins it: the work is committed with it. Works whatever the transaction mode.

Type Parameters

T

T

Parameters

fn

() => Promise<T>

the function

Returns

Promise<T>

the function result

claimingStore()

static claimingStore(model, stores?): Store<StoreParameters, StoreEvents> | undefined

Defined in: packages/core/lib/stores/store.d.ts:387

The store listing a model (or its closest ancestor) in its models

Parameters

model

ModelClass

the model

stores?

Store<StoreParameters, StoreEvents>[]

the candidate stores, every store of the application by default

Returns

Store<StoreParameters, StoreEvents> | undefined

the store, undefined when none lists it (the Registry serves it)

Inherited from

Store.claimingStore

computeStores()

static computeStores(): void

Defined in: packages/core/lib/stores/store.d.ts:405

Compute and register repositories for all known models based on available stores.

Called from Store.init() so each store's init triggers a recompute. Cannot be cached: the FIRST store to init (typically Registry) would claim every model with its fallback repository, and subsequent stores wouldn't get a chance to claim their configured models. Re-running is idempotent — registerRepository overwrites map entries in place, and the resolution loop is deterministic per current service/model state.

Returns

void

Inherited from

Store.computeStores

storeOf()

static storeOf(model): Store<StoreParameters, StoreEvents> | undefined

Defined in: packages/core/lib/stores/store.d.ts:393

The store serving a model: the one listing it, else the Registry

Parameters

model

ModelClass

the model

Returns

Store<StoreParameters, StoreEvents> | undefined

the store, undefined before the Registry exists

Inherited from

Store.storeOf

Abstract Class: SQLStore<K>

Extends​

Type Parameters​

K​

Implements​

Constructors​

Constructor​

Parameters​

name​

params​

Returns​

Inherited from​

Properties​

_compiledCapabilities​

See​

Inherited from​

_migratedBy?​

Inherited from​

_modelMetadatas​

Inherited from​

_models​

Inherited from​

_modelsHierarchy​

Index Signature​

Inherited from​

[WEBDA_EVENTS]​

Inherited from​

dialect​

explicitParticipant?​

logger​

Inherited from​

metrics​

operations_total​

queries​

slow_queries_total​

Inherited from​

name​

Implementation of​

Inherited from​

parameters​

Inherited from​

tablesReady​

createConfiguration?​

Parameters​

params​

Returns​

Inherited from​

filterConfiguration?​

Parameters​

params​

Returns​

Inherited from​

Parameters​

Inherited from​

Methods​

__clean()​

Returns​

Overrides​

acquireMigrationLease()​

Parameters​

name​

leaseDuration?​

Returns​

Throws​

Inherited from​

addListener()​

Type Parameters​

Key​

Parameters​

eventName​

listener​

Returns​

See​

Inherited from​

addRoute()​

Parameters​

url​

methods​

executer​

openapi?​

Extends

Type Parameters

K

Implements

Constructors

Constructor

Parameters

name

params

Returns

Inherited from

Properties

_compiledCapabilities

See

Inherited from

_migratedBy?

Inherited from

_modelMetadatas

Inherited from

_models

Inherited from

_modelsHierarchy

Index Signature

Inherited from

[WEBDA_EVENTS]

Inherited from

dialect

explicitParticipant?

logger

Inherited from

metrics

operations_total

queries

slow_queries_total

Inherited from

name

Implementation of

Inherited from

parameters

Inherited from

tablesReady

createConfiguration?

Parameters

params

Returns

Inherited from

filterConfiguration?

Parameters

params

Returns

Inherited from

Parameters

Inherited from

Methods

__clean()

Returns

Overrides

acquireMigrationLease()

Parameters

name

leaseDuration?

Returns

Throws

Inherited from

addListener()

Type Parameters

Key

Parameters

eventName

listener

Returns

See

Inherited from

addRoute()

Parameters

url

methods

executer

openapi?

override?