itemId          { items { id : value } }
itemKey         { items {key: value } }
instance, task  { instance: { id: instanceId }, items: { elementId: value }}
message         { items: { messageId: nameofmessage, key: value } {}
status          { items: {status: 'wait' } }
custom: { query: query, projection: projection }

New approach: just like MongoDB

itemId          { items { id : value } }
itemKey         { items {key: value } }
instance, task  {  id: instanceId , items.elementId: value }
message         { items.messageId: nameofmessage, key: value } {}
status          { items.status: 'wait' } }
custom: { query: query, projection: projection }

Problem with Mongodb: projection $elematch returns only the first record

Parameters#

Name	Type
`query`	`any`

Returns#

Promise\<IItemData[]>

Implementation of#

IDataStore.findItems

Defined in#

packages/bpmn-server/src/datastore/DataStore.ts:270

backup#

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

Every document of the instances, archive and locks collections, by collection name: for a backup.

Returns#

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

Implementation of#

IDataStore.backup

Defined in#

packages/bpmn-server/src/datastore/DataStore.ts:284

countInstances#

▸ countInstances(query): Promise\<number>

How many instances match query (MongoDB's query language, as findInstances).

Parameters#

Name	Type
`query`	`any`

Returns#

Promise\<number>

Implementation of#

IDataStore.countInstances

Defined in#

packages/bpmn-server/src/datastore/DataStore.ts:293

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>

Implementation of#

IDataStore.updateInstanceSource

Defined in#

packages/bpmn-server/src/datastore/DataStore.ts:300

tagInstance#

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

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

Parameters#

Name	Type
`instanceId`	`string`
`tag`	`any`

Returns#

Promise\<void>

Implementation of#

IDataStore.tagInstance

Defined in#

packages/bpmn-server/src/datastore/DataStore.ts:305

close#

▸ close(): Promise\<void>

Releases the store's connections.

Returns#

Promise\<void>

Implementation of#

IDataStore.close

Defined in#

packages/bpmn-server/src/datastore/DataStore.ts:309

deleteInstances#

▸ deleteInstances(query): Promise\<any>

Parameters#

Name	Type
`query`	`any`

Returns#

Promise\<any>

Implementation of#

IDataStore.deleteInstances

Defined in#

packages/bpmn-server/src/datastore/DataStore.ts:313

install#

▸ install(): Promise\<void>

first time installation of DB

creates a new collection and add an index

Returns#

Promise\<void>

Implementation of#

IDataStore.install

Defined in#

packages/bpmn-server/src/datastore/DataStore.ts:327

archive#

▸ archive(query): Promise\<void>

Parameters#

Name	Type
`query`	`any`

Returns#

Promise\<void>

Implementation of#

IDataStore.archive

Defined in#

packages/bpmn-server/src/datastore/DataStore.ts:334

find#

▸ find(«destructured»): Promise\<FindResult\<any>>

MongoDB Pagination class for finding instances in a collection. This module provides a function to retrieve paginated results from a MongoDB collection.
It allows filtering, sorting, and projecting fields in the results. The results can be paginated using a cursor for efficient data retrieval. all the parameters are optional and are passed to the findInstances method. * sort fields can be specified as an object with field names as keys and 1 (ascending) or -1 (descending) as values. * Sort by _id in descending order by default. * Sort field can be a nested field, e.g., data.caseId * Sort field can be a numeric or date field. * filter is an object that specifies the criteria for filtering the results. * after is a string that specifies the cursor for pagination, allowing you to retrieve results after a specific document. * * limit is a number that specifies the maximum number of documents to return in the result set. * * projection is an object that specifies which fields to include or exclude in the returned documents.

*

Parameters#

Name	Type
`«destructured»`	`FindParams`

Returns#

Promise\<FindResult\<any>>

Implementation of#

IDataStore.find

Defined in#

packages/bpmn-server/src/datastore/DataStore.ts:365

Class: DataStore#

Hierarchy#

Implements#

Table of contents#

Constructors#

Properties#

Accessors#

Methods#

Constructors#

constructor#

Parameters#

Returns#

Overrides#

Defined in#

Properties#

dbConfiguration#

Implementation of#

Defined in#

db#

Implementation of#

Defined in#

ownsDb#

Defined in#

execution#

Defined in#

isModified#

Defined in#

isRunning#

Defined in#

inSaving#

Defined in#

promises#

Defined in#

locker#

Implementation of#

Defined in#

enableSavePoints#

Defined in#

saveLogs#

Defined in#

saveSource#

Defined in#

seq#

Defined in#

server#

Inherited from#

Defined in#

Accessors#

configuration#

Returns#

Inherited from#

Defined in#

logger#

Returns#

Implementation of#

Inherited from#

Defined in#

cron#

Returns#

Inherited from#

Defined in#

cache#

Returns#

Inherited from#

Defined in#

appDelegate#

Returns#

Inherited from#

Defined in#

engine#

Returns#

Inherited from#

Defined in#

dataStore#

Returns#

Inherited from#

Defined in#

lockManager#

Returns#

Inherited from#