Skip to main content

StoreInterface

@webda/core


Interface: StoreInterface<T>

Defined in: packages/core/src/stores/store.ts:233

Internal

A Store is low-level storage service

It does not handle any business logic, only CRUD operations

— Store-internal contract. App code uses Repository<T> from @webda/models.

Type Parameters​

T​

T = any

Methods​

create()​

create(uuid, object): Promise<any>

Defined in: packages/core/src/stores/store.ts:237

Create operation

Parameters​

uuid​

PrimaryKey<any>

object​

any

Returns​

Promise<any>


delete()​

delete(uuid): Promise<void>

Defined in: packages/core/src/stores/store.ts:249

Delete operation

Parameters​

uuid​

PrimaryKey<any>

Returns​

Promise<void>


deleteItemFromCollection()​

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

Defined in: packages/core/src/stores/store.ts:276

Delete item from collection

Parameters​

uuid​

PrimaryKey<any>

collection​

string

index​

number

itemWriteConditionField?​

string

itemWriteCondition?​

any

Returns​

Promise<void>


exists()​

exists(uuid): Promise<boolean>

Defined in: packages/core/src/stores/store.ts:253

Perform exists

Parameters​

uuid​

PrimaryKey<any>

Returns​

Promise<boolean>


find()​

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

Defined in: packages/core/src/stores/store.ts:286

Find operation

Parameters​

query​

WebdaQLString<T>

Returns​

Promise<StoreFindResult<any>>


get()​

get(uuid): Promise<any>

Defined in: packages/core/src/stores/store.ts:241

Perform get

Parameters​

uuid​

PrimaryKey<any>

Returns​

Promise<any>


incrementAttributes()​

incrementAttributes(uuid, info): Promise<Date>

Defined in: packages/core/src/stores/store.ts:298

Perform increment attributes

Parameters​

uuid​

PrimaryKey<any>

info​

object[]

Returns​

Promise<Date>


iterate()​

iterate(query): AsyncGenerator

Defined in: packages/core/src/stores/store.ts:294

Perform iterate

Parameters​

query​

WebdaQLString<T>

Returns​

AsyncGenerator


query()​

query(query): Promise<StoreFindResult<any>>

Defined in: packages/core/src/stores/store.ts:290

Query operation

Parameters​

query​

WebdaQLString<T>

Returns​

Promise<StoreFindResult<any>>


removeAttribute()​

removeAttribute(uuid, attribute): Promise<void>

Defined in: packages/core/src/stores/store.ts:261

Remove attribute

Parameters​

uuid​

PrimaryKey<any>

attribute​

string

Returns​

Promise<void>


setAttribute()​

setAttribute(uuid, attribute, value): Promise<void>

Defined in: packages/core/src/stores/store.ts:257

Set the attribute

Parameters​

uuid​

PrimaryKey<any>

attribute​

string

value​

any

Returns​

Promise<void>


update()​

update(uuid, object): Promise<any>

Defined in: packages/core/src/stores/store.ts:245

Update operation

Parameters​

uuid​

PrimaryKey<any>

object​

any

Returns​

Promise<any>


upsertItemToCollection()​

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

Defined in: packages/core/src/stores/store.ts:265

Perform upsert item to collection

Parameters​

uuid​

PrimaryKey<any>

collection​

string

item​

any

index?​

number

itemWriteConditionField?​

string

itemWriteCondition?​

any

Returns​

Promise<void>