Skip to content

bpmn-server / IDataStore

Interface: IDataStore#

Implemented by#

Table of contents#

Properties#

Methods#

Properties#

dbConfiguration#

• Optional dbConfiguration: any

Deprecated

MongoDB's settings, for code written against the MongoDB data store; engine code does not read it.

Defined in#

packages/bpmn-server/src/interfaces/datastore.ts:26

db#

• Optional db: any

Deprecated

The data store's storage adapter; engine code uses the operations below.

Defined in#

packages/bpmn-server/src/interfaces/datastore.ts:28

logger#

• logger: any

Defined in#

packages/bpmn-server/src/interfaces/datastore.ts:29

locker#

• locker: ILockManager

The data store's own lock adapter; the engine uses the server's (server.locker), which is this one unless the configuration supplies another.

Defined in#

packages/bpmn-server/src/interfaces/datastore.ts:31

Methods#

save#

▸ save(instance, options): Promise\<void>

Parameters#

Name Type
instance any
options any

Returns#

Promise\<void>

Defined in#

packages/bpmn-server/src/interfaces/datastore.ts:32

saveInstance#

▸ saveInstance(instance, options?): Promise\<void>

Parameters#

Name Type
instance any
options? any

Returns#

Promise\<void>

Defined in#

packages/bpmn-server/src/interfaces/datastore.ts:33

updateInstanceSource#

▸ updateInstanceSource(instanceId, source): Promise\<void>

Replaces a saved instance's definition source (upgrading it to a newer model); the caller holds the instance's lock.

Parameters#

Name Type
instanceId string
source string

Returns#

Promise\<void>

Defined in#

packages/bpmn-server/src/interfaces/datastore.ts:35

tagInstance#

▸ tagInstance(instanceId, tag): Promise\<void>

Marks a saved instance with a tag of the caller's, which the engine's saves leave as it is.

Parameters#

Name Type
instanceId string
tag any

Returns#

Promise\<void>

Defined in#

packages/bpmn-server/src/interfaces/datastore.ts:37

close#

▸ close(): Promise\<void>

Releases the store's connections.

Returns#

Promise\<void>

Defined in#

packages/bpmn-server/src/interfaces/datastore.ts:39

loadInstance#

▸ loadInstance(instanceId, options): Promise\<{ instance: any ; items: any[] }>

Parameters#

Name Type
instanceId any
options any

Returns#

Promise\<{ instance: any ; items: any[] }>

Defined in#

packages/bpmn-server/src/interfaces/datastore.ts:40

findItem#

▸ findItem(query): Promise\<IItemData>

Parameters#

Name Type
query any

Returns#

Promise\<IItemData>

Defined in#

packages/bpmn-server/src/interfaces/datastore.ts:44

findInstance#

▸ findInstance(query, options): Promise\<IInstanceData>

Parameters#

Name Type
query any
options any

Returns#

Promise\<IInstanceData>

Defined in#

packages/bpmn-server/src/interfaces/datastore.ts:45

findInstances#

▸ findInstances(query, option): Promise\<IInstanceData[]>

Parameters#

Name Type
query any
option any

Returns#

Promise\<IInstanceData[]>

Defined in#

packages/bpmn-server/src/interfaces/datastore.ts:46

findItems#

▸ findItems(query): Promise\<IItemData[]>

Parameters#

Name Type
query any

Returns#

Promise\<IItemData[]>

Defined in#

packages/bpmn-server/src/interfaces/datastore.ts:47

countInstances#

▸ countInstances(query): Promise\<number>

How many instances match query.

Parameters#

Name Type
query any

Returns#

Promise\<number>

Defined in#

packages/bpmn-server/src/interfaces/datastore.ts:49

backup#

▸ backup(): Promise\<Record\<string, any[]>>

Every document the data store keeps, by collection name: for a backup.

Returns#

Promise\<Record\<string, any[]>>

Defined in#

packages/bpmn-server/src/interfaces/datastore.ts:51

deleteInstances#

▸ deleteInstances(query?): Promise\<void>

Parameters#

Name Type
query? any

Returns#

Promise\<void>

Defined in#

packages/bpmn-server/src/interfaces/datastore.ts:52

install#

▸ install(): any

Returns#

any

Defined in#

packages/bpmn-server/src/interfaces/datastore.ts:53

archive#

▸ archive(query): any

Parameters#

Name Type
query any

Returns#

any

Defined in#

packages/bpmn-server/src/interfaces/datastore.ts:54

find#

▸ find(FindParams): Promise\<FindResult\<any>>

Parameters#

Name Type
FindParams any

Returns#

Promise\<FindResult\<any>>

Defined in#

packages/bpmn-server/src/interfaces/datastore.ts:55

Comments