interface ds.DataStore

Abstraction around data storage in the form of document style records.

Eventicle contains a built in InMemoryDatastore. Others can be imported as needed.

Methods

Create a new entity in the datastore.

Signature

createEntity(workspaceId: string, type: string, content: any): Promise<Record>;

Remove a single Record by its ID

Signature

deleteEntity(workspaceId: string, type: string, id: string): Promise<void>;

Delete multiple from the Datastore via a result

Parameters
Name	Type	Description
`workspaceId`	`string`	the tenant
`type`	`string`	the Record type
`query`	`ds.Query`	The query, any matching Records will be deleted.
Returns	`Promise<void>`

Signature

deleteMany(workspaceId: string, type: string, query: Query): Promise<void>;

Find using a given , and optionally sort the results using a

Signature

findEntity(workspaceId: string, type: any, query: Query, sorting?: DataSorting): Promise<Record[]>;

Find using a given , and optionally sort the results using a , with pagination information provided in

Signature

findEntityPaginated(workspaceId: string, type: string, query: Query, sorting: DataSorting, page: number, pageSize: number): Promise<PagedRecords>;

Look up a single by its ID

Parameters
Name	Type	Description
`workspaceId`	`string`	when running on a multi-tenant Datastore, selects the tenant.
`type`	`string`	The type of the Record
`id`	`string`	The record ID
Returns	`Promise<ds.Record_2>`

Signature

getEntity(workspaceId: string, type: string, id: string): Promise<Record>;

Bag of data associated with the current transaction

Signature

getTransactionData(): TransactionData;

Whether transaction data currently exists in this context.

Signature

hasTransactionData(): boolean;

Parameters
Name	Type	Description
`event`	`'transaction.start'`
`listener`	`(name: string, data: ds.TransactionData) => void`
Returns	`this`

Signature

on(event: 'transaction.start', listener: (name: string, data: TransactionData) => void): this;

Parameters
Name	Type	Description
`event`	`'transaction.commit'`
`listener`	`(name: string, data: ds.TransactionData) => void`
Returns	`this`

Signature

on(event: 'transaction.commit', listener: (name: string, data: TransactionData) => void): this;

Save updates an existing entity

Parameters
Name	Type	Description
`workspaceId`	`string`	The tenant
`type`	`string`	the record type
`item`	`ds.Record_2`	The existing Record. Must have come from or
Returns	`Promise<ds.Record_2>`

Signature

saveEntity(workspaceId: string, type: string, item: Record): Promise<Record>;

Open a transaction (or optionally join one if it exists)

Parameters
Name	Type	Description
`exec`	`() => Promise<T>`	transaction is open within this execution. Once this function promise resolves, the transaction is committed or rolled back If `exec` Promise rejects, then the transaction is rolled back.
`options`	`ds.TransactionOptions`	if exists, controls if the trnasction should be new, or an existing on can be used.
Returns	`Promise<T>`

Signature

transaction<T>(exec: () => Promise<T>, options?: TransactionOptions): Promise<T>;