bpmn-server / MongoDB

Class: MongoDB

The MongoDB adapter of the storage port: one client, opened on first use, closed by close().

Implements

• IDocumentStore

Table of contents

Constructors

• constructor

Properties

• client
• connecting
• dbConfig
• logger
• operation

Methods

• profilerStart
• profilerEnd
• getClient
• find
• count
• createIndex
• insert
• update
• remove
• removeById
• close
• connect

Constructors

constructor

• new MongoDB(dbConfig, logger): MongoDB

Parameters

Name	Type
dbConfig	any
logger	any

Returns

MongoDB

Defined in

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

Properties

client

• client: MongoClient = null

Defined in

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

---

connecting

• Private connecting: Promise\<MongoClient> = null

Defined in

packages/bpmn-server/src/datastore/MongoDB.ts:30

---

dbConfig

• dbConfig: any

Defined in

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

---

logger

• logger: any

Defined in

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

---

operation

• operation: string

Defined in

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

Methods

profilerStart

▸ profilerStart(operation): void

Parameters

Name	Type
operation	string

Returns

void

Defined in

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

---

profilerEnd

▸ profilerEnd(): void

Returns

void

Defined in

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

---

getClient

▸ getClient(): Promise\<MongoClient>

Returns

Promise\<MongoClient>

Defined in

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

---

find

▸ find(dbName, collName, qry, projection?, sort?): Promise\<WithId\<Document>[]>

Documents of collection matching query, projected and sorted. database names the logical database (MongoDB's db name; ignored by single-database adapters).

Parameters

Name	Type	Default value
dbName	any	undefined
collName	any	undefined
qry	any	undefined
projection	any	null
sort	any	null

Returns

Promise\<WithId\<Document>[]>

Implementation of

IDocumentStore.find

Defined in

packages/bpmn-server/src/datastore/MongoDB.ts:56

---

count

▸ count(dbName, collName, qry): Promise\<number>

How many documents of collection match query. Optional: without it, callers count what find returns.

Parameters

Name	Type
dbName	any
collName	any
qry	any

Returns

Promise\<number>

Implementation of

IDocumentStore.count

Defined in

packages/bpmn-server/src/datastore/MongoDB.ts:72

---

createIndex

▸ createIndex(dbName, collName, index, unique?): Promise\<string>

Declares an index; { unique: true } makes insert refuse a second document with the same values. Idempotent.

Parameters

Name	Type
dbName	any
collName	any
index	any
unique	any

Returns

Promise\<string>

Implementation of

IDocumentStore.createIndex

Defined in

packages/bpmn-server/src/datastore/MongoDB.ts:83

---

insert

▸ insert(dbName, collName, docs): Promise\<number>

Inserts all of documents, or none: a unique-index conflict throws a DuplicateKeyError; any other failure throws as it is. Returns how many were inserted.

Parameters

Name	Type
dbName	any
collName	any
docs	any

Returns

Promise\<number>

Implementation of

IDocumentStore.insert

Defined in

packages/bpmn-server/src/datastore/MongoDB.ts:101

---

update

▸ update(dbName, collName, query, updateObject, options?): Promise\<number>

Updates the first document matching query ($set fields, or replaces it); { upsert: true } inserts when none matches. Returns how many were modified.

Parameters

Name	Type
dbName	any
collName	any
query	any
updateObject	any
options	any

Returns

Promise\<number>

Implementation of

IDocumentStore.update

Defined in

packages/bpmn-server/src/datastore/MongoDB.ts:117

---

remove

▸ remove(dbName, collName, query): Promise\<DeleteResult>

Removes every document matching query; returns { deletedCount }.

Parameters

Name	Type
dbName	any
collName	any
query	any

Returns

Promise\<DeleteResult>

Implementation of

IDocumentStore.remove

Defined in

packages/bpmn-server/src/datastore/MongoDB.ts:131

---

removeById

▸ removeById(dbName, collName, id): Promise\<DeleteResult>

Parameters

Name	Type
dbName	any
collName	any
id	any

Returns

Promise\<DeleteResult>

Defined in

packages/bpmn-server/src/datastore/MongoDB.ts:149

---

close

▸ close(): Promise\<void>

Releases connections. Idempotent.

Returns

Promise\<void>

Implementation of

IDocumentStore.close

Defined in

packages/bpmn-server/src/datastore/MongoDB.ts:163

---

connect

▸ connect(): Promise\<MongoClient>

Returns

Promise\<MongoClient>

Defined in

packages/bpmn-server/src/datastore/MongoDB.ts:170

Comments