bpmn-server / ModelsDatastoreDB

Class: ModelsDatastoreDB

super class for various objects that are part of the server

Hierarchy

• ServerComponent

↳ ModelsDatastoreDB

↳↳ ModelsDatastore

Implements

• IModelsDatastore

Table of contents

Constructors

• constructor

Properties

• dbConfiguration
• db
• ownsDb
• server

Accessors

• configuration
• logger
• cron
• cache
• appDelegate
• engine
• dataStore
• lockManager
• definitions
• listener
• scriptHandler

Methods

• close
• backup
• get
• getList
• loadFromInstance
• load
• loadDefinition
• getSource
• getSVG
• loadModel
• save
• findEvents
• getProjection
• install
• import
• updateTimer
• saveModel
• deleteModel
• renameModel
• export
• rebuild

Constructors

constructor

• new ModelsDatastoreDB(server): ModelsDatastoreDB

Parameters

Name	Type
server	IBPMNServer

Returns

ModelsDatastoreDB

Overrides

ServerComponent.constructor

Defined in

packages/bpmn-server/src/datastore/ModelsDatastoreDB.ts:23

Properties

dbConfiguration

• dbConfiguration: any

Defined in

packages/bpmn-server/src/datastore/ModelsDatastoreDB.ts:18

---

db

• db: any

The storage adapter: the server's shared documentStore, else this datastore's own MongoDB connection.

Defined in

packages/bpmn-server/src/datastore/ModelsDatastoreDB.ts:20

---

ownsDb

• Private Readonly ownsDb: boolean

Defined in

packages/bpmn-server/src/datastore/ModelsDatastoreDB.ts:21

---

server

• server: any

Inherited from

ServerComponent.server

Defined in

packages/bpmn-server/src/server/ServerComponent.ts:10

Accessors

configuration

• get configuration(): any

Returns

any

Inherited from

ServerComponent.configuration

Defined in

packages/bpmn-server/src/server/ServerComponent.ts:15

---

logger

• get logger(): any

Returns

any

Inherited from

ServerComponent.logger

Defined in

packages/bpmn-server/src/server/ServerComponent.ts:16

---

cron

• get cron(): Cron

Returns

Cron

Inherited from

ServerComponent.cron

Defined in

packages/bpmn-server/src/server/ServerComponent.ts:17

---

cache

• get cache(): ICacheManager

Returns

ICacheManager

Inherited from

ServerComponent.cache

Defined in

packages/bpmn-server/src/server/ServerComponent.ts:18

---

appDelegate

• get appDelegate(): any

Returns

any

Inherited from

ServerComponent.appDelegate

Defined in

packages/bpmn-server/src/server/ServerComponent.ts:19

---

engine

• get engine(): IEngine

Returns

IEngine

Inherited from

ServerComponent.engine

Defined in

packages/bpmn-server/src/server/ServerComponent.ts:20

---

dataStore

• get dataStore(): any

Returns

any

Inherited from

ServerComponent.dataStore

Defined in

packages/bpmn-server/src/server/ServerComponent.ts:21

---

lockManager

• get lockManager(): any

The lock port: the configuration's, else the data store's.

Returns

any

Inherited from

ServerComponent.lockManager

Defined in

packages/bpmn-server/src/server/ServerComponent.ts:23

---

definitions

• get definitions(): any

Returns

any

Inherited from

ServerComponent.definitions

Defined in

packages/bpmn-server/src/server/ServerComponent.ts:24

---

listener

• get listener(): any

Returns

any

Inherited from

ServerComponent.listener

Defined in

packages/bpmn-server/src/server/ServerComponent.ts:25

---

scriptHandler

• get scriptHandler(): any

Returns

any

Inherited from

ServerComponent.scriptHandler

Defined in

packages/bpmn-server/src/server/ServerComponent.ts:26

Methods

close

▸ close(): Promise\<void>

Returns

Promise\<void>

Defined in

packages/bpmn-server/src/datastore/ModelsDatastoreDB.ts:34

---

backup

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

Every document of the models and events collections, by collection name: for a backup.

Returns

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

Implementation of

IModelsDatastore.backup

Defined in

packages/bpmn-server/src/datastore/ModelsDatastoreDB.ts:38

---

get

▸ get(query?): Promise\<object[]>

Parameters

Name	Type
query	Object

Returns

Promise\<object[]>

Implementation of

IModelsDatastore.get

Defined in

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

---

getList

▸ getList(query?): Promise\<string[]>

Parameters

Name	Type
query	Object

Returns

Promise\<string[]>

Implementation of

IModelsDatastore.getList

Defined in

packages/bpmn-server/src/datastore/ModelsDatastoreDB.ts:50

---

loadFromInstance

▸ loadFromInstance(instance, owner?): Promise\<Definition>

load definition for instance

Parameters

Name	Type	Default value
instance	any	undefined
owner	any	null

Returns

Promise\<Definition>

Defined in

packages/bpmn-server/src/datastore/ModelsDatastoreDB.ts:67

---

load

▸ load(name, owner?): Promise\<Definition>

Parameters

Name	Type	Default value
name	any	undefined
owner	any	null

Returns

Promise\<Definition>

Implementation of

IModelsDatastore.load

Defined in

packages/bpmn-server/src/datastore/ModelsDatastoreDB.ts:80

---

loadDefinition

▸ loadDefinition(name, source): Promise\<Definition>

Parameters

Name	Type
name	any
source	any

Returns

Promise\<Definition>

Defined in

packages/bpmn-server/src/datastore/ModelsDatastoreDB.ts:86

---

getSource

▸ getSource(name, owner?): Promise\<any>

Parameters

Name	Type	Default value
name	any	undefined
owner	any	null

Returns

Promise\<any>

Implementation of

IModelsDatastore.getSource

Defined in

packages/bpmn-server/src/datastore/ModelsDatastoreDB.ts:93

---

getSVG

▸ getSVG(name, owner?): Promise\<any>

Parameters

Name	Type	Default value
name	any	undefined
owner	any	null

Returns

Promise\<any>

Implementation of

IModelsDatastore.getSVG

Defined in

packages/bpmn-server/src/datastore/ModelsDatastoreDB.ts:98

---

loadModel

▸ loadModel(name, owner?): Promise\<BpmnModelData>

Parameters

Name	Type	Default value
name	any	undefined
owner	any	null

Returns

Promise\<BpmnModelData>

Implementation of

IModelsDatastore.loadModel

Defined in

packages/bpmn-server/src/datastore/ModelsDatastoreDB.ts:107

---

save

▸ save(name, source, svg, owner?): Promise\<any>

savedBy: who saves it, kept in the model's history (files-based datastores)

Parameters

Name	Type	Default value
name	any	undefined
source	any	undefined
svg	any	undefined
owner	any	null

Returns

Promise\<any>

Implementation of

IModelsDatastore.save

Defined in

packages/bpmn-server/src/datastore/ModelsDatastoreDB.ts:118

---

findEvents

▸ findEvents(query, owner?): Promise\<IEventData[]>

Parameters

Name	Type	Default value
query	any	undefined
owner	any	null

Returns

Promise\<IEventData[]>

Implementation of

IModelsDatastore.findEvents

Defined in

packages/bpmn-server/src/datastore/ModelsDatastoreDB.ts:137

---

getProjection

▸ getProjection(query): Object

Parameters

Name	Type
query	any

Returns

Object

Defined in

packages/bpmn-server/src/datastore/ModelsDatastoreDB.ts:171

---

install

▸ install(): Promise\<any>

first time installation of DB

creates a new collection and add an index

Returns

Promise\<any>

Implementation of

IModelsDatastore.install

Defined in

packages/bpmn-server/src/datastore/ModelsDatastoreDB.ts:197

---

import

▸ import(data, owner?): Promise\<any>

Parameters

Name	Type	Default value
data	any	undefined
owner	any	null

Returns

Promise\<any>

Implementation of

IModelsDatastore.import

Defined in

packages/bpmn-server/src/datastore/ModelsDatastoreDB.ts:200

---

updateTimer

▸ updateTimer(name, owner?): Promise\<boolean>

Parameters

Name	Type	Default value
name	any	undefined
owner	any	null

Returns

Promise\<boolean>

Defined in

packages/bpmn-server/src/datastore/ModelsDatastoreDB.ts:204

---

saveModel

▸ saveModel(model, owner?): Promise\<boolean>

Parameters

Name	Type	Default value
model	IBpmnModelData	undefined
owner	any	null

Returns

Promise\<boolean>

Implementation of

IModelsDatastore.saveModel

Defined in

packages/bpmn-server/src/datastore/ModelsDatastoreDB.ts:230

---

deleteModel

▸ deleteModel(name, owner?): Promise\<void>

Parameters

Name	Type	Default value
name	any	undefined
owner	any	null

Returns

Promise\<void>

Implementation of

IModelsDatastore.deleteModel

Defined in

packages/bpmn-server/src/datastore/ModelsDatastoreDB.ts:250

---

renameModel

▸ renameModel(name, newName, owner?): Promise\<boolean>

Parameters

Name	Type	Default value
name	any	undefined
newName	any	undefined
owner	any	null

Returns

Promise\<boolean>

Implementation of

IModelsDatastore.renameModel

Defined in

packages/bpmn-server/src/datastore/ModelsDatastoreDB.ts:255

---

export

▸ export(name, folderPath, owner?): Promise\<void>

Parameters

Name	Type	Default value
name	any	undefined
folderPath	any	undefined
owner	any	null

Returns

Promise\<void>

Defined in

packages/bpmn-server/src/datastore/ModelsDatastoreDB.ts:273

---

rebuild

▸ rebuild(model?): Promise\<void>

Parameters

Name	Type	Default value
model	any	null

Returns

Promise\<void>

Implementation of

IModelsDatastore.rebuild

Defined in

packages/bpmn-server/src/datastore/ModelsDatastoreDB.ts:292

Comments