SQLStore

@webda/postgres • Readme | API

Class: `abstract` SQLStore<T, K>

Extends

Store<T, K>

Type parameters

• T extends CoreModel

• K extends SQLStoreParameters = SQLStoreParameters

Constructors

new SQLStore(webda, name, params)

new SQLStore<T, K>(webda, name, params?): SQLStore<T, K>

Service

Parameters

• webda: Core<CoreEvents>

The main instance of Webda

• name: string

The name of the service

• params?: DeepPartial<K>

The parameters block define in the configuration file

Returns

SQLStore<T, K>

Inherited from

`Store< T, K

.constructor`

Source

core/lib/services/service.d.ts:167

Properties

_cacheStore

_cacheStore: Store<T, StoreParameters, StoreEvents>

Cache store

Inherited from

Store._cacheStore

Source

core/lib/stores/store.d.ts:506

_createException

_createException: string

Inherited from

Store._createException

Source

core/lib/services/service.d.ts:148

_initException

_initException: any

Inherited from

Store._initException

Source

core/lib/services/service.d.ts:150

_initTime

_initTime: number

Inherited from

Store._initTime

Source

core/lib/services/service.d.ts:149

_model

_model: CoreModelDefinition<T>

Contains the current model

Inherited from

Store._model

Source

core/lib/stores/store.d.ts:517

_modelType

_modelType: string

Contains the current model type

Inherited from

Store._modelType

Source

core/lib/stores/store.d.ts:527

_modelsHierarchy

_modelsHierarchy: Object

Store teh manager hierarchy with their depth

Index signature

[key: string]: number

Inherited from

Store._modelsHierarchy

Source

core/lib/stores/store.d.ts:521

_name

protected _name: string

Service name

Inherited from

Store._name

Source

core/lib/services/service.d.ts:141

_reverseMap

_reverseMap: Object[]

Contain the reverse map

Inherited from

Store._reverseMap

Source

core/lib/stores/store.d.ts:510

_uuidField

protected _uuidField: string

Contain the model uuid field

Inherited from

Store._uuidField

Source

core/lib/stores/store.d.ts:531

_webda

protected _webda: Core<CoreEvents>

Webda Core object

Inherited from

Store._webda

Source

core/lib/services/service.d.ts:137

logger

protected logger: Logger

Logger with class context

Inherited from

Store.logger

Source

core/lib/services/service.d.ts:154

metrics

metrics: Object

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"}

Type declaration

cache_hits

cache_hits: Counter<string>

cache_invalidations

cache_invalidations: Counter<string>

operations_total

operations_total: Counter<string>

queries

queries: Histogram<string>

slow_queries_total

slow_queries_total: Counter<string>

Inherited from

Store.metrics

Source

core/lib/stores/store.d.ts:537

parameters

protected parameters: K

Hold the parameters for your service

It will be bring from the webda.config.json

Inherited from

Store.parameters

Source

core/lib/services/service.d.ts:147

captureRejectionSymbol

static readonly captureRejectionSymbol: typeof captureRejectionSymbol

Inherited from

Store.captureRejectionSymbol

Source

postgres/node_modules/@types/node/events.d.ts:328

captureRejections

static captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Inherited from

Store.captureRejections

Source

postgres/node_modules/@types/node/events.d.ts:333

defaultMaxListeners

static defaultMaxListeners: number

Inherited from

Store.defaultMaxListeners

Source

postgres/node_modules/@types/node/events.d.ts:334

errorMonitor

static readonly errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Inherited from

Store.errorMonitor

Source

postgres/node_modules/@types/node/events.d.ts:327

Methods

__clean()

__clean(): Promise<void>

Returns

Promise<void>

Overrides

Store.__clean

Source

postgres/src/sqlstore.ts:232

_delete()

_delete(uid, writeCondition, writeConditionField): Promise<void>

Parameters

• uid: string

• writeCondition: any

• writeConditionField: string

Returns

Promise<void>

Overrides

Store._delete

Source

postgres/src/sqlstore.ts:84

_deleteItemFromCollection()

protected abstract _deleteItemFromCollection(uid, prop, index, itemWriteCondition, itemWriteConditionField, updateDate): Promise<any>

Parameters

• uid: string

• prop: string

• index: number

• itemWriteCondition: any

• itemWriteConditionField: string

• updateDate: Date

Returns

Promise<any>

Inherited from

Store._deleteItemFromCollection

Source

core/lib/stores/store.d.ts:1005

_exists()

_exists(uid): Promise<boolean>

Parameters

• uid: string

Returns

Promise<boolean>

Overrides

Store._exists

Source

postgres/src/sqlstore.ts:159

_get()

_get(uid, raiseIfNotFound?): Promise<T>

Parameters

• uid: string

• raiseIfNotFound?: boolean

Returns

Promise<T>

Overrides

Store._get

Source

postgres/src/sqlstore.ts:170

_getFromCache()

_getFromCache(uuid, raiseIfNotFound?): Promise<T>

Get From Cache or main

Parameters

• uuid: string

• raiseIfNotFound?: boolean

Returns

Promise<T>

Inherited from

Store._getFromCache

Source

core/lib/stores/store.d.ts:582

_incrementAttributes()

protected abstract _incrementAttributes(uid, params, updateDate): Promise<any>

Increment the attribute

Parameters

• uid: string

• params: Object[]

• updateDate: Date

Returns

Promise<any>

Inherited from

Store._incrementAttributes

Source

core/lib/stores/store.d.ts:1000

_patch()

protected abstract _patch(object, uid, itemWriteCondition?, itemWriteConditionField?): Promise<any>

Parameters

• object: any

• uid: string

• itemWriteCondition?: any

• itemWriteConditionField?: string

Returns

Promise<any>

Inherited from

Store._patch

Source

core/lib/stores/store.d.ts:986

_removeAttribute()

protected abstract _removeAttribute(uuid, attribute, itemWriteCondition?, itemWriteConditionField?): Promise<void>

Parameters

• uuid: string

• attribute: string

• itemWriteCondition?: any

• itemWriteConditionField?: string

Returns

Promise<void>

Inherited from

Store._removeAttribute

Source

core/lib/stores/store.d.ts:987

_save()

_save(object): Promise<any>

Parameters

• object: T

Returns

Promise<any>

Overrides

Store._save

Source

postgres/src/sqlstore.ts:224

_update()

_update(object, uid, itemWriteCondition?, itemWriteConditionField?): Promise<any>

Parameters

• object: any

• uid: string

• itemWriteCondition?: any

• itemWriteConditionField?: string

Returns

Promise<any>

Overrides

Store._update

Source

postgres/src/sqlstore.ts:199

_upsertItemToCollection()

protected abstract _upsertItemToCollection(uid, prop, item, index, itemWriteCondition, itemWriteConditionField, updateDate): Promise<any>

Parameters

• uid: string

• prop: string

• item: any

• index: number

• itemWriteCondition: any

• itemWriteConditionField: string

• updateDate: Date

Returns

Promise<any>

Inherited from

Store._upsertItemToCollection

Source

core/lib/stores/store.d.ts:1004

addListener()

addListener(eventName, listener): this

Alias for emitter.on(eventName, listener).

Parameters

• eventName: string | symbol

• listener: (...args) => void

Returns

this

Inherited from

Store.addListener

Since

v0.1.26

Source

postgres/node_modules/@types/node/events.d.ts:354

addReverseMap()

addReverseMap(prop, store): void

Add reverse map information

Parameters

• prop: string

• store: MappingService<any>

Returns

void

Inherited from

Store.addReverseMap

Source

core/lib/stores/store.d.ts:629

addRoute()

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

Add a route dynamicaly

Parameters

• url: string

of the route can contains dynamic part like {uuid}

• methods: HttpMethodType[]

• executer: Function

Method to execute for this route

• openapi?: OpenAPIWebdaDefinition

• override?: boolean

Returns

void

Inherited from

Store.addRoute

Source

core/lib/services/service.d.ts:241

authorizeClientEvent()

authorizeClientEvent(_event, _context): boolean

Authorize a public event subscription

Parameters

• _event: string

• _context: OperationContext<any, any>

Returns

boolean

Inherited from

Store.authorizeClientEvent

Source

core/lib/services/service.d.ts:219

cacheStorePatchException()

cacheStorePatchException(): void

We should ignore exception from the store

Returns

void

Inherited from

Store.cacheStorePatchException

Source

core/lib/stores/store.d.ts:606

canTriggerConfiguration()

canTriggerConfiguration(_id, _callback): boolean

By default we cannot know if the store will trigger or not

Parameters

• _id: string

• _callback: () => void

Returns

boolean

Inherited from

Store.canTriggerConfiguration

Source

core/lib/stores/store.d.ts:863

cancelMigration()

cancelMigration(name): Promise<void>

Delete a migration

Parameters

• name: string

Returns

Promise<void>

Inherited from

Store.cancelMigration

Source

core/lib/stores/store.d.ts:815

cascadeDelete()

cascadeDelete(obj, _uuid): Promise<any>

Cascade delete a related object

Parameters

• obj: CoreModel

• _uuid: string

Returns

Promise<any>

Inherited from

Store.cascadeDelete

Source

core/lib/stores/store.d.ts:842

checkCollectionUpdateCondition()

checkCollectionUpdateCondition<FK, CK>(model, collection, conditionField?, condition?, index?): void

Check if an UpdateCondition is met

Type parameters

• FK extends string | number | symbol

• CK extends string | number | symbol

Parameters

• model: T

• collection: FK

• conditionField?: CK

• condition?: any

• index?: number

Returns

void

Inherited from

Store.checkCollectionUpdateCondition

Source

core/lib/stores/store.d.ts:759

checkUpdateCondition()

checkUpdateCondition<CK>(model, conditionField?, condition?, uid?): void

Check if an UpdateCondition is met

Type parameters

• CK extends string | number | symbol

Parameters

• model: T

• conditionField?: CK

• condition?: any

• uid?: string

Returns

void

Inherited from

Store.checkUpdateCondition

Source

core/lib/stores/store.d.ts:751

cleanModelAliases()

cleanModelAliases(): Promise<void>

Ensure model aliases are not used in this store

So alias can be cleaned

Returns

Promise<void>

Inherited from

Store.cleanModelAliases

Source

core/lib/stores/store.d.ts:802

completeQuery()

completeQuery(q): string

Add the SELECT * FROM table if the query is not a full query

Parameters

• q: string

query to complete

Returns

string

Source

postgres/src/sqlstore.ts:70

computeParameters()

computeParameters(): void

Retrieve the Model

Returns

void

Inherited from

Store.computeParameters

Throws

Error if model is not found

Source

core/lib/stores/store.d.ts:553

conditionalPatch()

conditionalPatch<CK>(uuid, updates, conditionField, condition): Promise<boolean>

Update conditionally

Type parameters

• CK extends string | number | symbol

Parameters

• uuid: string

• updates: Partial<T>

• conditionField: CK

• condition: any

Returns

Promise<boolean>

Inherited from

Store.conditionalPatch

Source

core/lib/stores/store.d.ts:767

create()

create(object, ctx?): Promise<any>

Parameters

• object: any

• ctx?: OperationContext<any, any>

Returns

Promise<any>

Inherited from

Store.create

Source

core/lib/stores/store.d.ts:735

delete()

delete<CK>(uid, writeCondition?, writeConditionField?, sync?): Promise<void>

Delete an object

Type parameters

• CK extends string | number | symbol

Parameters

• uid: string | T

• writeCondition?: any

• writeConditionField?: CK

• sync?: boolean

Returns

Promise<void>

the deletion promise

Inherited from

Store.delete

Source

core/lib/stores/store.d.ts:856

deleteItemFromCollection()

deleteItemFromCollection<FK>(uid, prop, index, itemWriteCondition, itemWriteConditionField?): Promise<Date>

Remove an item from an array in the model

Type parameters

• FK extends string | number | symbol

Parameters

• uid: string

of the model

• prop: FK

of the model to remove from

• index: number

of the item to remove in the array

• itemWriteCondition: any

value of the condition

• itemWriteConditionField?: string

field to read the condition from

Returns

Promise<Date>

Inherited from

Store.deleteItemFromCollection

Source

core/lib/stores/store.d.ts:669

duplicateExpression()

duplicateExpression(expression): Expression<string>

Parameters

• expression: Expression<string>

Returns

Expression<string>

Source

postgres/src/sqlstore.ts:98

emit()

emit<Key>(event, data): boolean

Override to allow capturing long listeners

Type parameters

• Key extends keyof StoreEvents

Parameters

• event: symbol | Key

• data: StoreEvents[Key]

Returns

boolean

Inherited from

Store.emit

Source

core/lib/services/service.d.ts:288

emitStoreEvent()

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

Handle StoreEvent and update cache based on it Then emit the event, it allows the cache to be updated before listeners are called

Type parameters

• Key extends keyof StoreEvents

Parameters

• event: Key

• data: StoreEvents[Key] & Object

Returns

Promise<void>

Inherited from

Store.emitStoreEvent

Source

core/lib/stores/store.d.ts:716

emitSync()

emitSync<Key>(event, data): Promise<any[]>

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

Type parameters

• Key extends keyof StoreEvents

Parameters

• event: Key

• data: StoreEvents[Key]

Returns

Promise<any[]>

Inherited from

Store.emitSync

Source

core/lib/services/service.d.ts:283

eventNames()

eventNames(): (string | symbol)[]

Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbols.

const EventEmitter = require('events');
const myEE = new EventEmitter();
myEE.on('foo', () => {});
myEE.on('bar', () => {});

const sym = Symbol('symbol');
myEE.on(sym, () => {});

console.log(myEE.eventNames());
// Prints: [ 'foo', 'bar', Symbol(symbol) ]

Returns

(string | symbol)[]

Inherited from

Store.eventNames

Since

v6.0.0

Source

postgres/node_modules/@types/node/events.d.ts:669

executeQuery()

abstract executeQuery(q, values?): Promise<SQLResult<T>>

Execute a SQL query

Parameters

• q: string

the query

• values?: any[]

to be added to the query

Returns

Promise<SQLResult<T>>

Source

postgres/src/sqlstore.ts:63

exists()

exists(uid): Promise<boolean>

Check if an object exists

Parameters

• uid: string | CoreModel

Returns

Promise<boolean>

Inherited from

Store.exists

Abstract

Params

uuid of the object or the object

Source

core/lib/stores/store.d.ts:952

find()

find(query): Promise<Object>

Parameters

• query: Query

Returns

Promise<Object>

continuationToken

continuationToken: string

filter

filter: Expression<string>

results

results: T[]

Overrides

Store.find

Source

postgres/src/sqlstore.ts:129

forceDelete()

forceDelete(uid): Promise<void>

Delete an object from the store without condition nor async

Parameters

• uid: string

to delete

Returns

Promise<void>

Inherited from

Store.forceDelete

Source

core/lib/stores/store.d.ts:848

get()

get(uid, ctx?, defaultValue?): Promise<T>

Get an object

Parameters

• uid: string

• ctx?: OperationContext<any, any>

• defaultValue?: any

Returns

Promise<T>

the object retrieved ( can be undefined if not found )

Inherited from

Store.get

Source

core/lib/stores/store.d.ts:884

getAll()

getAll(list?): Promise<T[]>

Parameters

• list?: string[]

Returns

Promise<T[]>

Overrides

Store.getAll

Source

postgres/src/sqlstore.ts:181

getClientEvents()

getClientEvents(): string[]

Return the events that an external system can subscribe to

Returns

string[]

Inherited from

Store.getClientEvents

Source

core/lib/services/service.d.ts:213

getConfiguration()

getConfiguration(id): Promise<Object>

Provide a way to store configuration in store

Parameters

• id: string

Returns

Promise<Object>

Inherited from

Store.getConfiguration

Source

core/lib/stores/store.d.ts:869

getMaxListeners()

getMaxListeners(): number

Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to defaultMaxListeners.

Returns

number

Inherited from

Store.getMaxListeners

Since

v1.0.0

Source

postgres/node_modules/@types/node/events.d.ts:526

getMetric()

getMetric<T>(type, configuration): T

Add service name label

Type parameters

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

Parameters

• type: Constructor<T, [MetricConfiguration<T>]>

• configuration: MetricConfiguration<T>

Returns

T

Inherited from

Store.getMetric

Source

core/lib/services/service.d.ts:207

getMigration()

getMigration(name): Promise<any>

Get a migration

Parameters

• name: string

Returns

Promise<any>

Inherited from

Store.getMigration

Source

core/lib/stores/store.d.ts:820

getModel()

getModel(): CoreModelDefinition<CoreModel>

Return Store current model

Returns

CoreModelDefinition<CoreModel>

Inherited from

Store.getModel

Source

core/lib/stores/store.d.ts:568

getName()

getName(): string

Get service name

Returns

string

Inherited from

Store.getName

Source

core/lib/services/service.d.ts:312

getObject()

getObject(uid): Promise<T>

Get object from store

Parameters

• uid: string

Returns

Promise<T>

Inherited from

Store.getObject

Source

core/lib/stores/store.d.ts:588

getOpenApiReplacements()

getOpenApiReplacements(): Object

Returns

Object

modelName

modelName: string

Inherited from

Store.getOpenApiReplacements

Source

core/lib/stores/store.d.ts:900

getOperationId()

getOperationId(id): string

If undefined is returned it cancel the operation registration

Parameters

• id: string

Returns

string

Inherited from

Store.getOperationId

Source

core/lib/services/service.d.ts:233

getParameters()

getParameters(): K

Get the service parameters

Returns

K

Inherited from

Store.getParameters

Source

core/lib/services/service.d.ts:179

getQueryCondition()

abstract getQueryCondition(itemWriteCondition, itemWriteConditionField, values): any

Parameters

• itemWriteCondition: any

• itemWriteConditionField: string

• values: any[]

Returns

any

Source

postgres/src/sqlstore.ts:194

getService()

getService<K>(service): K

Return a webda service

Type parameters

• K extends Service<ServiceParameters, Events>

Parameters

• service: string

name to retrieve

Returns

K

Inherited from

Store.getService

Source

core/lib/services/service.d.ts:308

getUrl()

getUrl(url, methods): string

Parameters

• url: string

• methods: HttpMethodType[]

Returns

string

Inherited from

Store.getUrl

Source

core/lib/stores/store.d.ts:592

getUuid()

getUuid(object): string

Parameters

• object: string | T | ModelLink<T>

Returns

string

Source

postgres/src/sqlstore.ts:212

getUuidField()

getUuidField(): string

Return the model uuid field

Returns

string

Inherited from

Store.getUuidField

Source

core/lib/stores/store.d.ts:946

getWebda()

getWebda(): Core<CoreEvents>

Return WebdaCore

Returns

Core<CoreEvents>

Inherited from

Store.getWebda

Source

core/lib/services/service.d.ts:183

handleModel()

handleModel(model): number

Return if a model is handled by the store

Parameters

• model: CoreModel | Constructor<CoreModel>

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

Source

core/lib/stores/store.d.ts:575

httpAction()

httpAction(ctx, actionMethod?): Promise<void>

Handle obect action

Parameters

• ctx: WebContext<any, any>

• actionMethod?: string

Returns

Promise<void>

Inherited from

Store.httpAction

Source

core/lib/stores/store.d.ts:918

httpCreate()

httpCreate(ctx): Promise<void>

Handle POST

Parameters

• ctx: WebContext<any, any>

Returns

Promise<void>

Inherited from

Store.httpCreate

Source

core/lib/stores/store.d.ts:907

httpDelete()

httpDelete(ctx): Promise<void>

Handle HTTP request

Parameters

• ctx: WebContext<any, any>

context of the request

Returns

Promise<void>

Inherited from

Store.httpDelete

Source

core/lib/stores/store.d.ts:942

httpGet()

httpGet(ctx): Promise<void>

Handle GET on object

Parameters

• ctx: WebContext<any, any>

context of the request

Returns

Promise<void>

Inherited from

Store.httpGet

Source

core/lib/stores/store.d.ts:935

httpGlobalAction()

httpGlobalAction(ctx, model?): Promise<void>

Handle collection action

Parameters

• ctx: WebContext<any, any>

• model?: CoreModelDefinition<CoreModel>

Returns

Promise<void>

Inherited from

Store.httpGlobalAction

Source

core/lib/stores/store.d.ts:923

httpQuery()

httpQuery(ctx): Promise<void>

Expose query to http

Parameters

• ctx: WebContext<any, any>

Returns

Promise<void>

Inherited from

Store.httpQuery

Source

core/lib/stores/store.d.ts:707

httpUpdate()

httpUpdate(ctx): Promise<void>

Handle HTTP Update for an object

Parameters

• ctx: WebContext<any, any>

context of the request

Returns

Promise<void>

Inherited from

Store.httpUpdate

Source

core/lib/stores/store.d.ts:929

incrementAttribute()

incrementAttribute<FK>(uid, prop, value): Promise<Date>

Helper function that call incrementAttributes

Type parameters

• FK extends string | number | symbol

Parameters

• uid: string

• prop: FK

• value: number

Returns

Promise<Date>

Inherited from

Store.incrementAttribute

Source

core/lib/stores/store.d.ts:648

incrementAttributes()

incrementAttributes<FK>(uid, info): Promise<Date>

Increment attributes of an object

Type parameters

• FK extends string | number | symbol

Parameters

• uid: string

• info: Object[]

Returns

Promise<Date>

Inherited from

Store.incrementAttributes

Source

core/lib/stores/store.d.ts:637

init()

init(): Promise<SQLStore<T, K>>

Will be called after all the Services are created

Returns

Promise<SQLStore<T, K>>

Inherited from

Store.init

Abstract

Source

core/lib/services/service.d.ts:274

initMetrics()

initMetrics(): void

Returns

void

Inherited from

Store.initMetrics

Source

core/lib/stores/store.d.ts:563

initModel()

protected initModel(object?): T

Init a model from the current stored data

Initial the reverse map as well

Parameters

• object?: any

Returns

T

Inherited from

Store.initModel

Source

core/lib/stores/store.d.ts:615

initOperations()

initOperations(): void

Init the operations

Returns

void

Inherited from

Store.initOperations

Source

core/lib/services/service.d.ts:254

initRoutes()

initRoutes(): void

Returns

void

Inherited from

Store.initRoutes

Inherit Doc

Source

core/lib/stores/store.d.ts:597

invalidateCache()

invalidateCache(uid): Promise<void>

Invalidate a cache entry

Parameters

• uid: string

Returns

Promise<void>

Inherited from

Store.invalidateCache

Source

core/lib/stores/store.d.ts:559

iterate()

iterate(query?, context?): AsyncGenerator<T, any, any>

Iterate through the results

This can be resource consuming

Parameters

• query?: string

• context?: OperationContext<any, any>

Returns

AsyncGenerator<T, any, any>

Inherited from

Store.iterate

Source

core/lib/stores/store.d.ts:678

listenerCount()

listenerCount(eventName): number

Returns the number of listeners listening to the event named eventName.

Parameters

• eventName: string | symbol

The name of the event being listened for

Returns

number

Inherited from

Store.listenerCount

Since

v3.2.0

Source

postgres/node_modules/@types/node/events.d.ts:616

listeners()

listeners(eventName): Function[]

Returns a copy of the array of listeners for the event named eventName.

server.on('connection', (stream) => {
  console.log('someone connected!');
});
console.log(util.inspect(server.listeners('connection')));
// Prints: [ [Function] ]

Parameters

• eventName: string | symbol

Returns

Function[]

Inherited from

Store.listeners

Since

v0.1.26

Source

postgres/node_modules/@types/node/events.d.ts:539

loadParameters()

abstract loadParameters(params): StoreParameters

Load the parameters for a service

Parameters

• params: any

Returns

StoreParameters

Inherited from

Store.loadParameters

Source

core/lib/stores/store.d.ts:547

log()

log(level, ...args): void

Parameters

• level: WorkerLogLevel

to log

• ...args: any[]

Returns

void

Inherited from

Store.log

Source

core/lib/services/service.d.ts:328

logSlowQuery()

logSlowQuery(_query, _reason, _time): void

Parameters

• _query: string

• _reason: string

• _time: number

Returns

void

Inherited from

Store.logSlowQuery

Source

core/lib/stores/store.d.ts:554

mapExpressionAttribute()

abstract mapExpressionAttribute(attribute, asString?): string

Parameters

• attribute: string[]

• asString?: boolean

Returns

string

Source

postgres/src/sqlstore.ts:96

migration()

migration(name, patcher, batchSize?): Promise<void>

Add a migration mechanism to store

Parameters

• name: string

• patcher: (object) => Promise<() => Promise<void> | Partial<T>>

• batchSize?: number

Returns

Promise<void>

Inherited from

Store.migration

Source

core/lib/stores/store.d.ts:826

newModel()

newModel(object?): T

Get a new model with this data preloaded

Parameters

• object?: any

Returns

T

Inherited from

Store.newModel

Source

core/lib/stores/store.d.ts:621

off()

off(eventName, listener): this

Alias for emitter.removeListener().

Parameters

• eventName: string | symbol

• listener: (...args) => void

Returns

this

Inherited from

Store.off

Since

v10.0.0

Source

postgres/node_modules/@types/node/events.d.ts:499

on()

on<Key>(event, listener): this

Type the listener part

Type parameters

• Key extends keyof StoreEvents

Parameters

• event: symbol | Key

• listener: (evt) => void

Returns

this

Inherited from

Store.on

Source

core/lib/services/service.d.ts:296

onAsync()

onAsync<Key>(event, listener, queue?): void

Listen to an event as on(...) would do except that it will be asynchronous

Type parameters

• Key extends keyof StoreEvents

Parameters

• event: Key

• listener: (evt) => void

• queue?: string

Name of queue to use, can be undefined, queue name are used to define differents priorities

Returns

void

Inherited from

Store.onAsync

Source

core/lib/services/service.d.ts:303

once()

once(eventName, listener): this

Adds a one-timelistener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.

server.once('connection', (stream) => {
  console.log('Ah, we have our first user!');
});

Returns a reference to the EventEmitter, so that calls can be chained.

By default, event listeners are invoked in the order they are added. Theemitter.prependOnceListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.

const myEE = new EventEmitter();
myEE.once('foo', () => console.log('a'));
myEE.prependOnceListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
//   b
//   a

Parameters

• eventName: string | symbol

The name of the event.

• listener: (...args) => void

The callback function

Returns

this

Inherited from

Store.once

Since

v0.3.0

Source

postgres/node_modules/@types/node/events.d.ts:414

operationCreate()

operationCreate(ctx, model): Promise<void>

Create a new object based on the context

Parameters

• ctx: OperationContext<any, any>

• model: string

Returns

Promise<void>

Inherited from

Store.operationCreate

Source

core/lib/stores/store.d.ts:913

patch()

patch<FK>(object, reverseMap?, conditionField?, conditionValue?): Promise<T>

Patch an object

Type parameters

• FK extends string | number | symbol

Parameters

• object: Partial<T>

• reverseMap?: boolean

• conditionField?: FK

• conditionValue?: any

Returns

Promise<T>

Inherited from

Store.patch

Source

core/lib/stores/store.d.ts:743

prependListener()

prependListener(eventName, listener): this

Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple times.

server.prependListener('connection', (stream) => {
  console.log('someone connected!');
});

Returns a reference to the EventEmitter, so that calls can be chained.

Parameters

• eventName: string | symbol

The name of the event.

• listener: (...args) => void

The callback function

Returns

this

Inherited from

Store.prependListener

Since

v6.0.0

Source

postgres/node_modules/@types/node/events.d.ts:634

prependOnceListener()

prependOnceListener(eventName, listener): this

Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this listener is removed, and then invoked.

server.prependOnceListener('connection', (stream) => {
  console.log('Ah, we have our first user!');
});

Returns a reference to the EventEmitter, so that calls can be chained.

Parameters

• eventName: string | symbol

The name of the event.

• listener: (...args) => void

The callback function

Returns

this

Inherited from

Store.prependOnceListener

Since

v6.0.0

Source

postgres/node_modules/@types/node/events.d.ts:650

put()

put(uuid, data): Promise<T>

Upsert the uuid object

Parameters

• uuid: string

• data: Partial<T>

Returns

Promise<T>

Inherited from

Store.put

Source

core/lib/stores/store.d.ts:877

query()

query(query, context?): Promise<Object>

Query store with WebdaQL

Parameters

• query: string

• context?: OperationContext<any, any>

to apply permission

Returns

Promise<Object>

continuationToken?

continuationToken?: string

results

results: T[]

Inherited from

Store.query

Source

core/lib/stores/store.d.ts:700

queryAll()

queryAll(query, context?): Promise<T[]>

Query all the results

Parameters

• query: string

• context?: OperationContext<any, any>

Returns

Promise<T[]>

Inherited from

Store.queryAll

Deprecated

use iterate instead

Source

core/lib/stores/store.d.ts:688

queryTypeUpdater()

queryTypeUpdater(query): Query

Check that __type Comparison is only used with = and CONTAINS If CONTAINS is used, move __type to __types If __type = store._model, remove it

Parameters

• query: Query

Returns

Query

Inherited from

Store.queryTypeUpdater

Source

core/lib/stores/store.d.ts:694

rawListeners()

rawListeners(eventName): Function[]

Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

const emitter = new EventEmitter();
emitter.once('log', () => console.log('log once'));

// Returns a new Array with a function `onceWrapper` which has a property
// `listener` which contains the original listener bound above
const listeners = emitter.rawListeners('log');
const logFnWrapper = listeners[0];

// Logs "log once" to the console and does not unbind the `once` event
logFnWrapper.listener();

// Logs "log once" to the console and removes the listener
logFnWrapper();

emitter.on('log', () => console.log('log persistently'));
// Will return a new Array with a single function bound by `.on()` above
const newListeners = emitter.rawListeners('log');

// Logs "log persistently" twice
newListeners[0]();
emitter.emit('log');

Parameters

• eventName: string | symbol

Returns

Function[]

Inherited from

Store.rawListeners

Since

v9.4.0

Source

postgres/node_modules/@types/node/events.d.ts:569

recomputeTypeCase()

recomputeTypeCase(): Promise<void>

Recompute type case

Returns

Promise<void>

Inherited from

Store.recomputeTypeCase

Source

core/lib/stores/store.d.ts:806

recomputeTypeShortId()

recomputeTypeShortId(): Promise<void>

Returns

Promise<void>

Inherited from

Store.recomputeTypeShortId

Source

core/lib/stores/store.d.ts:796

recomputeTypes()

recomputeTypes(): Promise<void>

Recompute the __types for all objects (storeMigration.Registry.typesCompute)

Returns

Promise<void>

Inherited from

Store.recomputeTypes

Source

core/lib/stores/store.d.ts:810

reinit()

reinit(config): Promise<SQLStore<T, K>>

Parameters

• config: DeepPartial<K>

new parameters for the service

Returns

Promise<SQLStore<T, K>>

Inherited from

Store.reinit

Source

core/lib/services/service.d.ts:279

removeAllListeners()

removeAllListeners(event?): this

Removes all listeners, or those of the specified eventName.

It is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).

Returns a reference to the EventEmitter, so that calls can be chained.

Parameters

• event?: string | symbol

Returns

this

Inherited from

Store.removeAllListeners

Since

v0.1.26

Source

postgres/node_modules/@types/node/events.d.ts:510

removeAttribute()

removeAttribute<CK>(uuid, attribute, itemWriteCondition?, itemWriteConditionField?): Promise<void>

Remove an attribute from an object

Type parameters

• CK extends string | number | symbol

Parameters

• uuid: string

• attribute: CK

• itemWriteCondition?: any

• itemWriteConditionField?: CK

Returns

Promise<void>

Inherited from

Store.removeAttribute

Source

core/lib/stores/store.d.ts:834

removeListener()

removeListener(eventName, listener): this

Removes the specified listener from the listener array for the event namedeventName.

const callback = (stream) => {
  console.log('someone connected!');
};
server.on('connection', callback);
// ...
server.removeListener('connection', callback);

removeListener() will remove, at most, one instance of a listener from the listener array. If any single listener has been added multiple times to the listener array for the specified eventName, then removeListener() must be called multiple times to remove each instance.

Once an event is emitted, all listeners attached to it at the time of emitting are called in order. This implies that anyremoveListener() or removeAllListeners() calls after emitting and before the last listener finishes execution will not remove them fromemit() in progress. Subsequent events behave as expected.

const myEmitter = new MyEmitter();

const callbackA = () => {
  console.log('A');
  myEmitter.removeListener('event', callbackB);
};

const callbackB = () => {
  console.log('B');
};

myEmitter.on('event', callbackA);

myEmitter.on('event', callbackB);

// callbackA removes listener callbackB but it will still be called.
// Internal listener array at time of emit [callbackA, callbackB]
myEmitter.emit('event');
// Prints:
//   A
//   B

// callbackB is now removed.
// Internal listener array [callbackA]
myEmitter.emit('event');
// Prints:
//   A

Because listeners are managed using an internal array, calling this will change the position indices of any listener registered after the listener being removed. This will not impact the order in which listeners are called, but it means that any copies of the listener array as returned by the emitter.listeners() method will need to be recreated.

When a single function has been added as a handler multiple times for a single event (as in the example below), removeListener() will remove the most recently added instance. In the example the once('ping')listener is removed:

const ee = new EventEmitter();

function pong() {
  console.log('pong');
}

ee.on('ping', pong);
ee.once('ping', pong);
ee.removeListener('ping', pong);

ee.emit('ping');
ee.emit('ping');

Returns a reference to the EventEmitter, so that calls can be chained.

Parameters

• eventName: string | symbol

• listener: (...args) => void

Returns

this

Inherited from

Store.removeListener

Since

v0.1.26

Source

postgres/node_modules/@types/node/events.d.ts:494

resolve()

resolve(): this

Resolve parameters Call initRoutes and initBeanRoutes

Returns

this

Inherited from

Store.resolve

Source

core/lib/services/service.d.ts:196

save()

save(object, ctx?): Promise<T>

Save an object

Parameters

• object: any

• ctx?: OperationContext<any, any>

Returns

Promise<T>

with saved object

Might want to rename to create

Inherited from

Store.save

Source

core/lib/stores/store.d.ts:728

setAttribute()

setAttribute<CK>(uid, property, value): Promise<void>

Set one attribute in an object

this is an helper function that calls patch

Type parameters

• CK extends string | number | symbol

Parameters

• uid: string

of the object

• property: CK

to update1

• value: any

new value

Returns

Promise<void>

Inherited from

Store.setAttribute

Source

core/lib/stores/store.d.ts:895

setMaxListeners()

setMaxListeners(n): this

By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set toInfinity (or 0) to indicate an unlimited number of listeners.

Returns a reference to the EventEmitter, so that calls can be chained.

Parameters

• n: number

Returns

this

Inherited from

Store.setMaxListeners

Since

v0.3.5

Source

postgres/node_modules/@types/node/events.d.ts:520

setModel()

setModel(model): void

OVerwrite the model Used mainly in test

Parameters

• model: CoreModelDefinition<T>

Returns

void

Inherited from

Store.setModel

Source

core/lib/stores/store.d.ts:602

simulateFind()

protected simulateFind(query, uuids): Promise<StoreFindResult<T>>

Parameters

• query: Query

• uuids: string[]

Returns

Promise<StoreFindResult<T>>

Inherited from

Store.simulateFind

Source

core/lib/stores/store.d.ts:899

simulateUpsertItemToCollection()

simulateUpsertItemToCollection<FK>(model, prop, item, updateDate, index?, itemWriteCondition?, itemWriteConditionField?): Promise<void>

Type parameters

• FK extends string | number | symbol

Parameters

• model: T

• prop: FK

• item: any

• updateDate: Date

• index?: number

• itemWriteCondition?: any

• itemWriteConditionField?: string

Returns

Promise<void>

Inherited from

Store.simulateUpsertItemToCollection

Source

core/lib/stores/store.d.ts:778

sqlQuery()

sqlQuery(q, values?): Promise<SQLResult<T>>

Parameters

• q: string

• values?: any[]

Returns

Promise<SQLResult<T>>

Source

postgres/src/sqlstore.ts:53

stop()

stop(): Promise<void>

Shutdown the current service if action need to be taken

Returns

Promise<void>

Inherited from

Store.stop

Source

core/lib/services/service.d.ts:187

toJSON()

toJSON(): string

Prevent service to be serialized

Returns

string

Inherited from

Store.toJSON

Source

core/lib/services/service.d.ts:267

toPublicJSON()

toPublicJSON(object): string

Convert an object to JSON using the Webda json filter

Service

Parameters

• object: unknown

The object to export

Returns

string

The export of the strip object ( removed all attribute with _ )

Inherited from

Store.toPublicJSON

Source

core/lib/services/service.d.ts:262

toString()

toString(): string

Return service representation

Returns

string

Inherited from

Store.toString

Source

core/lib/services/service.d.ts:191

update()

update<CK>(object, reverseMap?, partial?, conditionField?, conditionValue?): Promise<T>

Update an object

If no attribute can be updated then return undefined

Type parameters

• CK extends string | number | symbol

Parameters

• object: any

• reverseMap?: boolean

internal use only, for disable map resolution

• partial?: boolean

• conditionField?: CK

• conditionValue?: any

Returns

Promise<T>

with saved object

Inherited from

Store.update

Source

core/lib/stores/store.d.ts:788

upsertItemToCollection()

upsertItemToCollection<FK>(uid, prop, item, index?, itemWriteCondition?, itemWriteConditionField?): Promise<Date>

Add or update an item to an array in the model

Type parameters

• FK extends string | number | symbol

Parameters

• uid: string

of the model

• prop: FK

of the model to add in

• item: any

to add in the array

• index?: number

if specified update item in this index

• itemWriteCondition?: any

value of the condition to test (in case of update)

• itemWriteConditionField?: string

field to read the condition from (in case of update)

Returns

Promise<Date>

Inherited from

Store.upsertItemToCollection

Source

core/lib/stores/store.d.ts:659

v3Migration()

v3Migration(): Promise<void>

Manage the store migration for __type case sensitivity

Returns

Promise<void>

Inherited from

Store.v3Migration

Source

core/lib/stores/store.d.ts:792

getEventListeners()

static getEventListeners(emitter, name): Function[]

Returns a copy of the array of listeners for the event named eventName.

For EventEmitters this behaves exactly the same as calling .listeners on the emitter.

For EventTargets this is the only way to get the event listeners for the event target. This is useful for debugging and diagnostic purposes.

const { getEventListeners, EventEmitter } = require('events');

{
  const ee = new EventEmitter();
  const listener = () => console.log('Events are fun');
  ee.on('foo', listener);
  getEventListeners(ee, 'foo'); // [listener]
}
{
  const et = new EventTarget();
  const listener = () => console.log('Events are fun');
  et.addEventListener('foo', listener);
  getEventListeners(et, 'foo'); // [listener]
}

Parameters

• emitter: EventEmitter | _DOMEventTarget

• name: string | symbol

Returns

Function[]

Inherited from

Store.getEventListeners

Since

v15.2.0, v14.17.0

Source

postgres/node_modules/@types/node/events.d.ts:299

getOpenAPI()

static getOpenAPI(): void

Returns

void

Inherited from

Store.getOpenAPI

Source

core/lib/stores/store.d.ts:593

listenerCount()

static listenerCount(emitter, eventName): number

A class method that returns the number of listeners for the given eventNameregistered on the given emitter.

const { EventEmitter, listenerCount } = require('events');
const myEmitter = new EventEmitter();
myEmitter.on('event', () => {});
myEmitter.on('event', () => {});
console.log(listenerCount(myEmitter, 'event'));
// Prints: 2

Parameters

• emitter: EventEmitter

The emitter to query

• eventName: string | symbol

The event name

Returns

number

Inherited from

Store.listenerCount

Since

v0.9.12

Deprecated

Since v3.2.0 - Use listenerCount instead.

Source

postgres/node_modules/@types/node/events.d.ts:271

on()

static on(emitter, eventName, options?): AsyncIterableIterator<any, any, any>

const { on, EventEmitter } = require('events');

(async () => {
  const ee = new EventEmitter();

  // Emit later on
  process.nextTick(() => {
    ee.emit('foo', 'bar');
    ee.emit('foo', 42);
  });

  for await (const event of on(ee, 'foo')) {
    // The execution of this inner block is synchronous and it
    // processes one event at a time (even with await). Do not use
    // if concurrent execution is required.
    console.log(event); // prints ['bar'] [42]
  }
  // Unreachable here
})();

Returns an AsyncIterator that iterates eventName events. It will throw if the EventEmitter emits 'error'. It removes all listeners when exiting the loop. The value returned by each iteration is an array composed of the emitted event arguments.

An AbortSignal can be used to cancel waiting on events:

const { on, EventEmitter } = require('events');
const ac = new AbortController();

(async () => {
  const ee = new EventEmitter();

  // Emit later on
  process.nextTick(() => {
    ee.emit('foo', 'bar');
    ee.emit('foo', 42);
  });

  for await (const event of on(ee, 'foo', { signal: ac.signal })) {
    // The execution of this inner block is synchronous and it
    // processes one event at a time (even with await). Do not use
    // if concurrent execution is required.
    console.log(event); // prints ['bar'] [42]
  }
  // Unreachable here
})();

process.nextTick(() => ac.abort());

Parameters

• emitter: EventEmitter

• eventName: string

The name of the event being listened for

• options?: StaticEventEmitterOptions

Returns

AsyncIterableIterator<any, any, any>

that iterates eventName events emitted by the emitter

Inherited from

Store.on

Since

v13.6.0, v12.16.0

Source

postgres/node_modules/@types/node/events.d.ts:254

once()

once(emitter, eventName, options)

static once(emitter, eventName, options?): Promise<any[]>

Creates a Promise that is fulfilled when the EventEmitter emits the given event or that is rejected if the EventEmitter emits 'error' while waiting. The Promise will resolve with an array of all the arguments emitted to the given event.

This method is intentionally generic and works with the web platform EventTarget interface, which has no special'error' event semantics and does not listen to the 'error' event.

const { once, EventEmitter } = require('events');

async function run() {
  const ee = new EventEmitter();

  process.nextTick(() => {
    ee.emit('myevent', 42);
  });

  const [value] = await once(ee, 'myevent');
  console.log(value);

  const err = new Error('kaboom');
  process.nextTick(() => {
    ee.emit('error', err);
  });

  try {
    await once(ee, 'myevent');
  } catch (err) {
    console.log('error happened', err);
  }
}

run();

The special handling of the 'error' event is only used when events.once()is used to wait for another event. If events.once() is used to wait for the 'error' event itself, then it is treated as any other kind of event without special handling:

const { EventEmitter, once } = require('events');

const ee = new EventEmitter();

once(ee, 'error')
  .then(([err]) => console.log('ok', err.message))
  .catch((err) => console.log('error', err.message));

ee.emit('error', new Error('boom'));

// Prints: ok boom

An AbortSignal can be used to cancel waiting for the event:

const { EventEmitter, once } = require('events');

const ee = new EventEmitter();
const ac = new AbortController();

async function foo(emitter, event, signal) {
  try {
    await once(emitter, event, { signal });
    console.log('event emitted!');
  } catch (error) {
    if (error.name === 'AbortError') {
      console.error('Waiting for the event was canceled!');
    } else {
      console.error('There was an error', error.message);
    }
  }
}

foo(ee, 'foo', ac.signal);
ac.abort(); // Abort waiting for the event
ee.emit('foo'); // Prints: Waiting for the event was canceled!

Parameters

• emitter: _NodeEventTarget

• eventName: string | symbol

• options?: StaticEventEmitterOptions

Returns

Promise<any[]>

Inherited from

Store.once

Since

v11.13.0, v10.16.0

Source

postgres/node_modules/@types/node/events.d.ts:194

once(emitter, eventName, options)

static once(emitter, eventName, options?): Promise<any[]>

Parameters

• emitter: _DOMEventTarget

• eventName: string

• options?: StaticEventEmitterOptions

Returns

Promise<any[]>

Inherited from

Store.once

Source

postgres/node_modules/@types/node/events.d.ts:195

setMaxListeners()

static setMaxListeners(n?, ...eventTargets?): void

const {
  setMaxListeners,
  EventEmitter
} = require('events');

const target = new EventTarget();
const emitter = new EventEmitter();

setMaxListeners(5, target, emitter);

Parameters

• n?: number

A non-negative number. The maximum number of listeners per EventTarget event.

• ...eventTargets?: (EventEmitter | _DOMEventTarget)[]

Returns

void

Inherited from

Store.setMaxListeners

Since

v15.4.0

Source

postgres/node_modules/@types/node/events.d.ts:317

Class: abstract SQLStore<T, K>

Extends​

Type parameters​

Constructors​

new SQLStore(webda, name, params)​

Parameters​

Returns​

Inherited from​

Source​

Properties​

_cacheStore​

Inherited from​

Source​

_createException​

Inherited from​

Source​

_initException​

Inherited from​

Source​

_initTime​

Inherited from​

Source​

_model​

Inherited from​

Source​

_modelType​

Inherited from​

Source​

_modelsHierarchy​

Index signature​

Inherited from​

Source​

_name​

Inherited from​

Source​

_reverseMap​

Inherited from​

Source​

_uuidField​

Inherited from​

Source​

_webda​

Inherited from​

Source​

logger​

Inherited from​

Source​

metrics​

Type declaration​

cache_hits​

cache_invalidations​

operations_total​

queries​

slow_queries_total​

Inherited from​

Source​

parameters​

Inherited from​

Source​

captureRejectionSymbol​

Inherited from​

Source​

captureRejections​

Inherited from​

Source​

defaultMaxListeners​

Inherited from​

Source​

errorMonitor​

Inherited from​

Source​

Methods​

__clean()​

Returns​

Overrides​

Source​

_delete()​

Parameters​

Returns​

Overrides​

Class: `abstract` SQLStore<T, K>

Extends

Type parameters

Constructors

new SQLStore(webda, name, params)

Parameters

Returns

Inherited from

Source

Properties

_cacheStore

Inherited from

Source

_createException

Inherited from

Source

_initException

Inherited from

Source

_initTime

Inherited from

Source

_model

Inherited from

Source

_modelType

Inherited from

Source

_modelsHierarchy

Index signature

Inherited from

Source

_name

Inherited from

Source

_reverseMap

Inherited from

Source

_uuidField

Inherited from

Source

_webda

Inherited from

Source

logger

Inherited from

Source

metrics

Type declaration

cache_hits

cache_invalidations

operations_total

queries

slow_queries_total

Inherited from

Source

parameters

Inherited from

Source

captureRejectionSymbol

Inherited from

Source

captureRejections

Inherited from

Source

defaultMaxListeners

Inherited from

Source

errorMonitor

Inherited from

Source

Methods

__clean()

Returns

Overrides

Source

_delete()

Parameters

Returns

Overrides