Skip to main content

@webda/aws • Readme | API

Class: DynamoStore<T, K>

DynamoStore handles the DynamoDB

Parameters: accessKeyId: '' // try WEBDA_AWS_KEY env variable if not found secretAccessKey: '' // try WEBDA_AWS_SECRET env variable if not found table: '' region: ''

Webda Modda​

Extends​

  • Store<T, K>

Type parameters​

• T extends CoreModel = CoreModel

• K extends DynamoStoreParameters = DynamoStoreParameters

Implements​

Constructors​

new DynamoStore(webda, name, params)​

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

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​

DynamoStore<T, K>

Inherited from​

Store<T, K>.constructor

Source​

packages/core/lib/services/service.d.ts:168

Properties​

_cacheStore​

_cacheStore: Store<T, StoreParameters, StoreEvents>

Cache store

Inherited from​

Store._cacheStore

Source​

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

_client​

_client: DynamoDBDocument

Source​

packages/aws/src/services/dynamodb.ts:74

_createException​

_createException: string

Inherited from​

Store._createException

Source​

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

_initException​

_initException: any

Inherited from​

Store._initException

Source​

packages/core/lib/services/service.d.ts:151

_initTime​

_initTime: number

Inherited from​

Store._initTime

Source​

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

_model​

_model: CoreModelDefinition<T>

Contains the current model

Inherited from​

Store._model

Source​

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

_modelType​

_modelType: string

Contains the current model type

Inherited from​

Store._modelType

Source​

packages/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​

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

_name​

protected _name: string

Service name

Inherited from​

Store._name

Source​

packages/core/lib/services/service.d.ts:142

_reverseMap​

_reverseMap: Object[]

Contain the reverse map

Inherited from​

Store._reverseMap

Source​

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

_uuidField​

protected _uuidField: string

Contain the model uuid field

Inherited from​

Store._uuidField

Source​

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

_webda​

protected _webda: Core<CoreEvents>

Webda Core object

Inherited from​

Store._webda

Source​

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

logger​

protected logger: Logger

Logger with class context

Inherited from​

Store.logger

Source​

packages/core/lib/services/service.d.ts:155

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​

packages/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​

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

captureRejectionSymbol​

static readonly captureRejectionSymbol: typeof captureRejectionSymbol

Inherited from​

Store.captureRejectionSymbol

Source​

node_modules/@types/node/events.d.ts:38

captureRejections​

static captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Inherited from​

Store.captureRejections

Source​

node_modules/@types/node/events.d.ts:44

defaultMaxListeners​

static defaultMaxListeners: number

Inherited from​

Store.defaultMaxListeners

Source​

node_modules/@types/node/events.d.ts:45

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​

node_modules/@types/node/events.d.ts:37

Methods​

__clean()​

__clean(): Promise<void>

Returns​

Promise<void>

Overrides​

Store.__clean

Inherit Doc​

Source​

packages/aws/src/services/dynamodb.ts:742

_cleanObject()​

_cleanObject(object): any

Clean object to store in DynamoDB

Parameters​

• object: Object

Returns​

any

Source​

packages/aws/src/services/dynamodb.ts:347

_delete()​

_delete(uid, writeCondition?, itemWriteConditionField?): Promise<void>

Parameters​

• uid: string

• writeCondition?: any

• itemWriteConditionField?: string

Returns​

Promise<void>

Overrides​

Store._delete

Inherit Doc​

Source​

packages/aws/src/services/dynamodb.ts:529

_deleteItemFromCollection()​

_deleteItemFromCollection(uid, prop, index, itemWriteCondition, itemWriteConditionField, updateDate): Promise<void>

Parameters​

• uid: any

• prop: any

• index: any

• itemWriteCondition: any

• itemWriteConditionField: any

• updateDate: Date

Returns​

Promise<void>

Overrides​

Store._deleteItemFromCollection

Inherit Doc​

Source​

packages/aws/src/services/dynamodb.ts:412

_exists()​

_exists(uid): Promise<boolean>

Parameters​

• uid: any

Returns​

Promise<boolean>

Overrides​

Store._exists

Inherit Doc​

Source​

packages/aws/src/services/dynamodb.ts:141

_get()​

_get(uid, raiseIfNotFound): Promise<T>

Parameters​

• uid: string

• raiseIfNotFound: boolean= false

Returns​

Promise<T>

Overrides​

Store._get

Inherit Doc​

Source​

packages/aws/src/services/dynamodb.ts:664

_getFromCache()​

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

Get From Cache or main

Parameters​

• uuid: string

• raiseIfNotFound?: boolean

Returns​

Promise<T>

Inherited from​

Store._getFromCache

Source​

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

_incrementAttributes()​

_incrementAttributes(uid, parameters, updateDate): Promise<UpdateCommandOutput>

Parameters​

• uid: any

• parameters: Object[]

• updateDate: Date

Returns​

Promise<UpdateCommandOutput>

Overrides​

Store._incrementAttributes

Inherit Doc​

Source​

packages/aws/src/services/dynamodb.ts:684

_patch()​

_patch(object, uid, itemWriteCondition?, itemWriteConditionField?): Promise<void>

Parameters​

• object: any

• uid: string

• itemWriteCondition?: any

• itemWriteConditionField?: string

Returns​

Promise<void>

Overrides​

Store._patch

Inherit Doc​

Source​

packages/aws/src/services/dynamodb.ts:552

_removeAttribute()​

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

Parameters​

• uuid: string

• attribute: string

• itemWriteCondition?: any

• itemWriteConditionField?: string

Returns​

Promise<void>

Overrides​

Store._removeAttribute

Inherit Doc​

Source​

packages/aws/src/services/dynamodb.ts:373

_save()​

_save(object, uid): Promise<any>

Parameters​

• object: any

• uid: string= object.uuid

Returns​

Promise<any>

Overrides​

Store._save

Inherit Doc​

Source​

packages/aws/src/services/dynamodb.ts:149

_scan()​

_scan(items, paging): Promise<T[]>

Parameters​

• items: any[]= []

• paging: any= undefined

Returns​

Promise<T[]>

Inherit Doc​

Source​

packages/aws/src/services/dynamodb.ts:625

_serializeDate()​

_serializeDate(date): string

Serialize a date for DynamoDB

Parameters​

• date: Date

Returns​

string

Source​

packages/aws/src/services/dynamodb.ts:337

_update()​

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

Parameters​

• object: any

• uid: string

• itemWriteCondition?: any

• itemWriteConditionField?: string

Returns​

Promise<any>

Overrides​

Store._update

Inherit Doc​

Source​

packages/aws/src/services/dynamodb.ts:600

_upsertItemToCollection()​

_upsertItemToCollection(uuid, prop, item, index, itemWriteCondition, itemWriteConditionField, updateDate): Promise<void>

Parameters​

• uuid: string

• prop: string

• item: any

• index: number

• itemWriteCondition: any

• itemWriteConditionField: string

• updateDate: Date

Returns​

Promise<void>

Overrides​

Store._upsertItemToCollection

Inherit Doc​

Source​

packages/aws/src/services/dynamodb.ts:448

addListener()​

addListener(event, listener): this

Parameters​

• event: string | symbol

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

Returns​

this

Inherited from​

Store.addListener

Source​

node_modules/@types/node/events.d.ts:57

addReverseMap()​

addReverseMap(prop, store): void

Add reverse map information

Parameters​

• prop: string

• store: MappingService<any>

Returns​

void

Inherited from​

Store.addReverseMap

Source​

packages/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​

packages/core/lib/services/service.d.ts:242

authorizeClientEvent()​

authorizeClientEvent(_event, _context): boolean

Authorize a public event subscription

Parameters​

• _event: string

• _context: OperationContext<any, any>

Returns​

boolean

Inherited from​

Store.authorizeClientEvent

Source​

packages/core/lib/services/service.d.ts:220

cacheStorePatchException()​

cacheStorePatchException(): void

We should ignore exception from the store

Returns​

void

Inherited from​

Store.cacheStorePatchException

Source​

packages/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​

packages/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​

packages/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​

packages/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​

packages/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​

packages/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​

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

computeParameters()​

computeParameters(): void

Retrieve the Model

Returns​

void

Inherited from​

Store.computeParameters

Throws​

Error if model is not found

Source​

packages/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​

packages/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​

packages/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​

packages/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​

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

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​

packages/core/lib/services/service.d.ts:289

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​

packages/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​

packages/core/lib/services/service.d.ts:284

eventNames()​

eventNames(): (string | symbol)[]

Returns​

(string | symbol)[]

Inherited from​

Store.eventNames

Source​

node_modules/@types/node/events.d.ts:72

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​

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

find()​

find(query): Promise<StoreFindResult<T>>

Parameters​

• query: Query

Returns​

Promise<StoreFindResult<T>>

Overrides​

Store.find

See​

Source​

packages/aws/src/services/dynamodb.ts:159

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​

packages/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​

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

getARNPolicy()​

getARNPolicy(accountId): Object

Parameters​

• accountId: string

Returns​

Object

Action​

Action: string[]

Effect​

Effect: string = "Allow"

Resource​

Resource: string[]

Sid​

Sid: string

Inherit Doc​

Source​

packages/aws/src/services/dynamodb.ts:718

getAll()​

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

Parameters​

• uids?: string[]

Returns​

Promise<T[]>

Overrides​

Store.getAll

Inherit Doc​

Source​

packages/aws/src/services/dynamodb.ts:643

getClientEvents()​

getClientEvents(): string[]

Return the events that an external system can subscribe to

Returns​

string[]

Inherited from​

Store.getClientEvents

Source​

packages/core/lib/services/service.d.ts:214

getCloudFormation()​

getCloudFormation(deployer): Object

S3Binary.getCloudFormation

Parameters​

• deployer: default

The current deployer asking for contribution

Returns​

Object

Implementation of​

CloudFormationContributor.getCloudFormation

Source​

packages/aws/src/services/dynamodb.ts:757

getConfiguration()​

getConfiguration(id): Promise<Object>

Provide a way to store configuration in store

Parameters​

• id: string

Returns​

Promise<Object>

Inherited from​

Store.getConfiguration

Source​

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

getMaxListeners()​

getMaxListeners(): number

Returns​

number

Inherited from​

Store.getMaxListeners

Source​

node_modules/@types/node/events.d.ts:64

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​

packages/core/lib/services/service.d.ts:208

getMigration()​

getMigration(name): Promise<any>

Get a migration

Parameters​

• name: string

Returns​

Promise<any>

Inherited from​

Store.getMigration

Source​

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

getModel()​

getModel(): CoreModelDefinition<CoreModel>

Return Store current model

Returns​

CoreModelDefinition<CoreModel>

Inherited from​

Store.getModel

Source​

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

getName()​

getName(): string

Get service name

Returns​

string

Inherited from​

Store.getName

Source​

packages/core/lib/services/service.d.ts:313

getObject()​

getObject(uid): Promise<T>

Get object from store

Parameters​

• uid: string

Returns​

Promise<T>

Inherited from​

Store.getObject

Source​

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

getOpenApiReplacements()​

getOpenApiReplacements(): Object

Returns​

Object

modelName​

modelName: string

Inherited from​

Store.getOpenApiReplacements

Source​

packages/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​

packages/core/lib/services/service.d.ts:234

getParameters()​

getParameters(): K

Get the service parameters

Returns​

K

Inherited from​

Store.getParameters

Source​

packages/core/lib/services/service.d.ts:180

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​

packages/core/lib/services/service.d.ts:309

getUrl()​

getUrl(url, methods): string

Parameters​

• url: string

• methods: HttpMethodType[]

Returns​

string

Inherited from​

Store.getUrl

Source​

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

getUuidField()​

getUuidField(): string

Return the model uuid field

Returns​

string

Inherited from​

Store.getUuidField

Source​

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

getWebda()​

getWebda(): Core<CoreEvents>

Return WebdaCore

Returns​

Core<CoreEvents>

Inherited from​

Store.getWebda

Source​

packages/core/lib/services/service.d.ts:184

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​

packages/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​

packages/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​

packages/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​

packages/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​

packages/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​

packages/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​

packages/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​

packages/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​

packages/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​

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

init()​

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

Will be called after all the Services are created

Returns​

Promise<DynamoStore<T, K>>

Inherited from​

Store.init

Abstract​

Source​

packages/core/lib/services/service.d.ts:275

initMetrics()​

initMetrics(): void

Returns​

void

Inherited from​

Store.initMetrics

Source​

packages/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​

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

initOperations()​

initOperations(): void

Init the operations

Returns​

void

Inherited from​

Store.initOperations

Source​

packages/core/lib/services/service.d.ts:255

initRoutes()​

initRoutes(): void

Returns​

void

Inherited from​

Store.initRoutes

Inherit Doc​

Source​

packages/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​

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

iterate()​

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

Iterate through the results

This can be resource consuming

Parameters​

• query?: string

• context?: OperationContext<any, any>

Returns​

AsyncGenerator<T, any, unknown>

Inherited from​

Store.iterate

Source​

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

listenerCount()​

listenerCount(event): number

Parameters​

• event: string | symbol

Returns​

number

Inherited from​

Store.listenerCount

Source​

node_modules/@types/node/events.d.ts:68

listeners()​

listeners(event): Function[]

Parameters​

• event: string | symbol

Returns​

Function[]

Inherited from​

Store.listeners

Source​

node_modules/@types/node/events.d.ts:65

loadParameters()​

loadParameters(params): DynamoStoreParameters

Load the parameters

Parameters​

• params: any

Returns​

DynamoStoreParameters

Overrides​

Store.loadParameters

Source​

packages/aws/src/services/dynamodb.ts:81

log()​

log(level, ...args): void

Parameters​

• level: WorkerLogLevel

to log

• ...args: any[]

Returns​

void

Inherited from​

Store.log

Source​

packages/core/lib/services/service.d.ts:329

logSlowQuery()​

logSlowQuery(_query, _reason, _time): void

Parameters​

• _query: string

• _reason: string

• _time: number

Returns​

void

Inherited from​

Store.logSlowQuery

Source​

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

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​

packages/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​

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

off()​

off(event, listener): this

Parameters​

• event: string | symbol

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

Returns​

this

Inherited from​

Store.off

Source​

node_modules/@types/node/events.d.ts:61

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​

packages/core/lib/services/service.d.ts:297

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​

packages/core/lib/services/service.d.ts:304

once()​

once(event, listener): this

Parameters​

• event: string | symbol

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

Returns​

this

Inherited from​

Store.once

Source​

node_modules/@types/node/events.d.ts:59

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​

packages/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​

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

prependListener()​

prependListener(event, listener): this

Parameters​

• event: string | symbol

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

Returns​

this

Inherited from​

Store.prependListener

Source​

node_modules/@types/node/events.d.ts:70

prependOnceListener()​

prependOnceListener(event, listener): this

Parameters​

• event: string | symbol

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

Returns​

this

Inherited from​

Store.prependOnceListener

Source​

node_modules/@types/node/events.d.ts:71

put()​

put(uuid, data): Promise<T>

Upsert the uuid object

Parameters​

• uuid: string

• data: Partial<T>

Returns​

Promise<T>

Inherited from​

Store.put

Source​

packages/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​

packages/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​

packages/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​

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

rawListeners()​

rawListeners(event): Function[]

Parameters​

• event: string | symbol

Returns​

Function[]

Inherited from​

Store.rawListeners

Source​

node_modules/@types/node/events.d.ts:66

recomputeTypeCase()​

recomputeTypeCase(): Promise<void>

Recompute type case

Returns​

Promise<void>

Inherited from​

Store.recomputeTypeCase

Source​

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

recomputeTypeShortId()​

recomputeTypeShortId(): Promise<void>

Returns​

Promise<void>

Inherited from​

Store.recomputeTypeShortId

Source​

packages/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​

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

reinit()​

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

Parameters​

• config: DeepPartial<K>

new parameters for the service

Returns​

Promise<DynamoStore<T, K>>

Inherited from​

Store.reinit

Source​

packages/core/lib/services/service.d.ts:280

removeAllListeners()​

removeAllListeners(event?): this

Parameters​

• event?: string | symbol

Returns​

this

Inherited from​

Store.removeAllListeners

Source​

node_modules/@types/node/events.d.ts:62

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​

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

removeListener()​

removeListener(event, listener): this

Parameters​

• event: string | symbol

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

Returns​

this

Inherited from​

Store.removeListener

Source​

node_modules/@types/node/events.d.ts:60

resolve()​

resolve(): this

Create the AWS client

Returns​

this

Overrides​

Store.resolve

Source​

packages/aws/src/services/dynamodb.ts:88

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​

packages/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​

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

setMaxListeners()​

setMaxListeners(n): this

Parameters​

• n: number

Returns​

this

Inherited from​

Store.setMaxListeners

Source​

node_modules/@types/node/events.d.ts:63

setModel()​

setModel(model): void

OVerwrite the model Used mainly in test

Parameters​

• model: CoreModelDefinition<T>

Returns​

void

Inherited from​

Store.setModel

Source​

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

setWriteCondition()​

setWriteCondition(params, writeCondition, field): void

REturn the write condition as string

Parameters​

• params: any

• writeCondition: any

• field: string= "_lastUpdate"

Returns​

void

Source​

packages/aws/src/services/dynamodb.ts:515

simulateFind()​

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

Parameters​

• query: Query

• uuids: string[]

Returns​

Promise<StoreFindResult<T>>

Inherited from​

Store.simulateFind

Source​

packages/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​

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

stop()​

stop(): Promise<void>

Shutdown the current service if action need to be taken

Returns​

Promise<void>

Inherited from​

Store.stop

Source​

packages/core/lib/services/service.d.ts:188

toJSON()​

toJSON(): string

Prevent service to be serialized

Returns​

string

Inherited from​

Store.toJSON

Source​

packages/core/lib/services/service.d.ts:268

toPublicJSON()​

toPublicJSON(object): string

Convert an object to JSON using the Webda json filter

Parameters​

• object: unknown

The object to export

Returns​

string

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

Inherited from​

Store.toPublicJSON

Source​

packages/core/lib/services/service.d.ts:263

toString()​

toString(): string

Return service representation

Returns​

string

Inherited from​

Store.toString

Source​

packages/core/lib/services/service.d.ts:192

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​

packages/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​

packages/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​

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

copyTable()​

static copyTable(output, source, target): Promise<void>

Copy one DynamoDB table to another

Parameters​

• output: WorkerOutput

• source: string

• target: string

Returns​

Promise<void>

Source​

packages/aws/src/services/dynamodb.ts:105

getOpenAPI()​

static getOpenAPI(): void

Returns​

void

Inherited from​

Store.getOpenAPI

Source​

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

listenerCount()​

static listenerCount(emitter, event): number

Parameters​

• emitter: EventEmitter

• event: string | symbol

Returns​

number

Inherited from​

Store.listenerCount

Deprecated​

since v4.0.0

Source​

node_modules/@types/node/events.d.ts:26

on()​

static on(emitter, event): AsyncIterableIterator<any>

Parameters​

• emitter: EventEmitter

• event: string

Returns​

AsyncIterableIterator<any>

Inherited from​

Store.on

Source​

node_modules/@types/node/events.d.ts:23

once()​

once(emitter, event)​

static once(emitter, event): Promise<any[]>

Parameters​

• emitter: NodeEventTarget

• event: string | symbol

Returns​

Promise<any[]>

Inherited from​

Store.once

Source​

node_modules/@types/node/events.d.ts:21

once(emitter, event)​

static once(emitter, event): Promise<any[]>

Parameters​

• emitter: DOMEventTarget

• event: string

Returns​

Promise<any[]>

Inherited from​

Store.once

Source​

node_modules/@types/node/events.d.ts:22