bpmn-server / IModelsDatastore
Interface: IModelsDatastore#
Implemented by#
Table of contents#
Methods#
- get
- getList
- getSource
- getSVG
- save
- load
- loadModel
- findEvents
- rebuild
- backup
- install
- import
- saveModel
- deleteModel
- renameModel
- history
- historySource
- deleteVersion
- purgeHistory
Methods#
get#
▸ get(query): Promise\<object[]>
Parameters#
| Name | Type |
|---|---|
query |
any |
Returns#
Promise\<object[]>
Defined in#
packages/bpmn-server/src/interfaces/datastore.ts:59
getList#
▸ getList(query): Promise\<string[]>
Parameters#
| Name | Type |
|---|---|
query |
any |
Returns#
Promise\<string[]>
Defined in#
packages/bpmn-server/src/interfaces/datastore.ts:60
getSource#
▸ getSource(name, owner?): Promise\<string>
Parameters#
| Name | Type |
|---|---|
name |
any |
owner? |
any |
Returns#
Promise\<string>
Defined in#
packages/bpmn-server/src/interfaces/datastore.ts:61
getSVG#
▸ getSVG(name, owner?): Promise\<string>
Parameters#
| Name | Type |
|---|---|
name |
any |
owner? |
any |
Returns#
Promise\<string>
Defined in#
packages/bpmn-server/src/interfaces/datastore.ts:62
save#
▸ save(name, bpmn, svg?, owner?, savedBy?): Promise\<boolean>
savedBy: who saves it, kept in the model's history (files-based datastores)
Parameters#
| Name | Type |
|---|---|
name |
any |
bpmn |
any |
svg? |
any |
owner? |
any |
savedBy? |
string |
Returns#
Promise\<boolean>
Defined in#
packages/bpmn-server/src/interfaces/datastore.ts:64
load#
▸ load(name, owner?): Promise\<IDefinition>
Parameters#
| Name | Type |
|---|---|
name |
any |
owner? |
any |
Returns#
Promise\<IDefinition>
Defined in#
packages/bpmn-server/src/interfaces/datastore.ts:66
loadModel#
▸ loadModel(name, owner?): Promise\<IBpmnModelData>
Parameters#
| Name | Type |
|---|---|
name |
any |
owner? |
any |
Returns#
Promise\<IBpmnModelData>
Defined in#
packages/bpmn-server/src/interfaces/datastore.ts:67
findEvents#
▸ findEvents(query, owner?): Promise\<any[]>
Parameters#
| Name | Type |
|---|---|
query |
any |
owner? |
any |
Returns#
Promise\<any[]>
Defined in#
packages/bpmn-server/src/interfaces/datastore.ts:68
rebuild#
▸ rebuild(model?): Promise\<void>
Parameters#
| Name | Type |
|---|---|
model? |
any |
Returns#
Promise\<void>
Defined in#
packages/bpmn-server/src/interfaces/datastore.ts:69
backup#
▸ backup(): Promise\<Record\<string, any[]>>
Every document the models datastore keeps, by collection name: for a backup.
Returns#
Promise\<Record\<string, any[]>>
Defined in#
packages/bpmn-server/src/interfaces/datastore.ts:71
install#
▸ install(): any
Returns#
any
Defined in#
packages/bpmn-server/src/interfaces/datastore.ts:73
import#
▸ import(data): any
Parameters#
| Name | Type |
|---|---|
data |
any |
Returns#
any
Defined in#
packages/bpmn-server/src/interfaces/datastore.ts:74
saveModel#
▸ saveModel(model): Promise\<boolean>
Parameters#
| Name | Type |
|---|---|
model |
IBpmnModelData |
Returns#
Promise\<boolean>
Defined in#
packages/bpmn-server/src/interfaces/datastore.ts:75
deleteModel#
▸ deleteModel(name, owner?): Promise\<void>
Parameters#
| Name | Type |
|---|---|
name |
any |
owner? |
any |
Returns#
Promise\<void>
Defined in#
packages/bpmn-server/src/interfaces/datastore.ts:76
renameModel#
▸ renameModel(name, newName, owner?): Promise\<boolean>
Parameters#
| Name | Type |
|---|---|
name |
any |
newName |
any |
owner? |
any |
Returns#
Promise\<boolean>
Defined in#
packages/bpmn-server/src/interfaces/datastore.ts:77
history#
▸ history(name): Promise\<{ version: number ; savedAt: string ; savedBy?: string ; size: number }[]>
A model's saved versions, newest first (files-based datastores: ModelHistory).
Parameters#
| Name | Type |
|---|---|
name |
string |
Returns#
Promise\<{ version: number ; savedAt: string ; savedBy?: string ; size: number }[]>
Defined in#
packages/bpmn-server/src/interfaces/datastore.ts:79
historySource#
▸ historySource(name, version): Promise\<string>
A saved version of a model, or null.
Parameters#
| Name | Type |
|---|---|
name |
string |
version |
number |
Returns#
Promise\<string>
Defined in#
packages/bpmn-server/src/interfaces/datastore.ts:81
deleteVersion#
▸ deleteVersion(name, version): Promise\<boolean>
Removes one saved version of a model; false when there is none.
Parameters#
| Name | Type |
|---|---|
name |
string |
version |
number |
Returns#
Promise\<boolean>
Defined in#
packages/bpmn-server/src/interfaces/datastore.ts:83
purgeHistory#
▸ purgeHistory(name): Promise\<number>
Removes a model's history; returns how many versions it had.
Parameters#
| Name | Type |
|---|---|
name |
string |
Returns#
Promise\<number>
Defined in#
packages/bpmn-server/src/interfaces/datastore.ts:85