Skip to content

bpmn-server / ModelsDatastoreDB

Class: ModelsDatastoreDB#

super class for various objects that are part of the server

Hierarchy#

↳ ModelsDatastoreDB

↳↳ ModelsDatastore

Implements#

Table of contents#

Constructors#

Properties#

Accessors#

Methods#

Constructors#

constructor#

• new ModelsDatastoreDB(server): ModelsDatastoreDB

Parameters#

Name Type
server BPMNServer

Returns#

ModelsDatastoreDB

Overrides#

ServerComponent.constructor

Defined in#

datastore/ModelsDatastoreDB.ts:27

Properties#

dbConfiguration#

• dbConfiguration: any

Defined in#

datastore/ModelsDatastoreDB.ts:24

db#

• db: any

Defined in#

datastore/ModelsDatastoreDB.ts:25

server#

• server: any

Inherited from#

ServerComponent.server

Defined in#

server/ServerComponent.ts:9

Accessors#

configuration#

• get configuration(): any

Returns#

any

Inherited from#

ServerComponent.configuration

Defined in#

server/ServerComponent.ts:14

logger#

• get logger(): any

Returns#

any

Inherited from#

ServerComponent.logger

Defined in#

server/ServerComponent.ts:15

cron#

• get cron(): Cron

Returns#

Cron

Inherited from#

ServerComponent.cron

Defined in#

server/ServerComponent.ts:16

cache#

• get cache(): CacheManager

Returns#

CacheManager

Inherited from#

ServerComponent.cache

Defined in#

server/ServerComponent.ts:17

appDelegate#

• get appDelegate(): any

Returns#

any

Inherited from#

ServerComponent.appDelegate

Defined in#

server/ServerComponent.ts:18

engine#

• get engine(): IEngine

Returns#

IEngine

Inherited from#

ServerComponent.engine

Defined in#

server/ServerComponent.ts:19

dataStore#

• get dataStore(): any

Returns#

any

Inherited from#

ServerComponent.dataStore

Defined in#

server/ServerComponent.ts:20

definitions#

• get definitions(): any

Returns#

any

Inherited from#

ServerComponent.definitions

Defined in#

server/ServerComponent.ts:21

listener#

• get listener(): any

Returns#

any

Inherited from#

ServerComponent.listener

Defined in#

server/ServerComponent.ts:22

Methods#

get#

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

Parameters#

Name Type
query Object

Returns#

Promise\<object[]>

Implementation of#

IModelsDatastore.get

Defined in#

datastore/ModelsDatastoreDB.ts:34

getList#

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

Parameters#

Name Type
query Object

Returns#

Promise\<string[]>

Implementation of#

IModelsDatastore.getList

Defined in#

datastore/ModelsDatastoreDB.ts:40

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#

datastore/ModelsDatastoreDB.ts:54

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#

datastore/ModelsDatastoreDB.ts:61

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#

datastore/ModelsDatastoreDB.ts:66

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#

datastore/ModelsDatastoreDB.ts:75

save#

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

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#

datastore/ModelsDatastoreDB.ts:85

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#

datastore/ModelsDatastoreDB.ts:104

getProjection#

▸ getProjection(query): Object

Parameters#

Name Type
query any

Returns#

Object

Defined in#

datastore/ModelsDatastoreDB.ts:138

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#

datastore/ModelsDatastoreDB.ts:164

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#

datastore/ModelsDatastoreDB.ts:167

updateTimer#

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

Parameters#

Name Type Default value
name any undefined
owner any null

Returns#

Promise\<boolean>

Defined in#

datastore/ModelsDatastoreDB.ts:171

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#

datastore/ModelsDatastoreDB.ts:197

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#

datastore/ModelsDatastoreDB.ts:217

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#

datastore/ModelsDatastoreDB.ts:222

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#

datastore/ModelsDatastoreDB.ts:240

rebuild#

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

Parameters#

Name Type Default value
model any null

Returns#

Promise\<void>

Defined in#

datastore/ModelsDatastoreDB.ts:258