Class MongoStore<V>

Store based on MongoDB

Implements

Type Parameters

V

Hierarchy

MongoStore

Implements

Store<V>

Index

Constructors

constructor

new MongoStore<V>(db: Connection, eltTyp: Provable<V>, smtName: string): MongoStore<V>
Creates an instance of MongoStore.

Memberof
MongoStore
Type Parameters
- V
Parameters
- db: Connection
- eltTyp: Provable<V>
- smtName: string
Returns MongoStore<V>
- Defined in src/lib/store/mongo_store.ts:41

Properties

`Protected` db

db: Connection

`Protected` eltTyp

eltTyp: Provable<V>

`Protected` nodesModel

nodesModel: Model<IKV, {}, {}, {}, any>

`Protected` nodesOperationCache

nodesOperationCache: any[]

`Protected` valuesModel

valuesModel: Model<IKV, {}, {}, {}, any>

`Protected` valuesOperationCache

valuesOperationCache: any[]

Methods

clear

clear(): Promise<void>
Clear the store.

Returns
{Promise}

Memberof
MongoStore

Returns Promise<void>
Implementation of Store.clear
- Defined in src/lib/store/mongo_store.ts:228

clearPrepareOperationCache

clearPrepareOperationCache(): void
Clear all prepare operation cache.

Memberof
MongoStore

Returns void
Implementation of Store.clearPrepareOperationCache
- Defined in src/lib/store/mongo_store.ts:55

commit

commit(): Promise<void>
Use the commit() method to actually submit all prepare changes.

Returns
{Promise}

Memberof
MongoStore

Returns Promise<void>
Implementation of Store.commit
- Defined in src/lib/store/mongo_store.ts:210

getNodes

getNodes(key: Field): Promise<Field[]>
Get nodes for a key. Error is thrown when a key that does not exist is being accessed.

Returns
{Promise<Field[]>}

Memberof
MongoStore
Parameters
- key: Field
Returns Promise<Field[]>
Implementation of Store.getNodes
- Defined in src/lib/store/mongo_store.ts:94

getRoot

getRoot(): Promise<Field>
Get the tree root. Error is thrown when the root does not exist.

Returns
{Promise}

Memberof
MongoStore

Returns Promise<Field>
Implementation of Store.getRoot
- Defined in src/lib/store/mongo_store.ts:66

getValue

getValue(path: Field): Promise<V>
Get the value for a key. Error is thrown when a key that does not exist is being accessed.

Returns
{Promise}

Memberof
MongoStore
Parameters
- path: Field
Returns Promise<V>
Implementation of Store.getValue
- Defined in src/lib/store/mongo_store.ts:152

getValuesMap

getValuesMap(): Promise<Map<string, V>>
Get values map, key is Field.toString().

Returns
{Promise<Map<string, V>>}

Memberof
MongoStore

Returns Promise<Map<string, V>>
Implementation of Store.getValuesMap
- Defined in src/lib/store/mongo_store.ts:239

prepareDelNodes

prepareDelNodes(key: Field): void
Prepare delete nodes for a key. Use the commit() method to actually submit changes.

Memberof
MongoStore
Parameters
- key: Field
Returns void
Implementation of Store.prepareDelNodes
- Defined in src/lib/store/mongo_store.ts:123

prepareDelValue

prepareDelValue(path: Field): void
Prepare delete the value for a key. Use the commit() method to actually submit changes.

Memberof
MongoStore
Parameters
- path: Field
Returns void
Implementation of Store.prepareDelValue
- Defined in src/lib/store/mongo_store.ts:196

preparePutNodes

preparePutNodes(key: Field, value: Field[]): void
Prepare put nodes for a key. Use the commit() method to actually submit changes.

Memberof
MongoStore
Parameters
- key: Field
- value: Field[]
Returns void
Implementation of Store.preparePutNodes
- Defined in src/lib/store/mongo_store.ts:107

preparePutValue

preparePutValue(path: Field, value: V): void
Prepare put the value for a key. Use the commit() method to actually submit changes.

Memberof
MongoStore
Parameters
- path: Field
- value: V
Returns void
Implementation of Store.preparePutValue
- Defined in src/lib/store/mongo_store.ts:178

prepareUpdateRoot

prepareUpdateRoot(root: Field): void
Prepare update the root. Use the commit() method to actually submit changes.

Memberof
MongoStore
Parameters
- root: Field
Returns void
Implementation of Store.prepareUpdateRoot
- Defined in src/lib/store/mongo_store.ts:77

`Protected` strToValue

strToValue(valueStr: string, eltTyp: Provable<V>): V
Protected
Convert value string to a value of FieldElements type.

Returns
{V}

Memberof
MongoStore
Parameters
- valueStr: string
- eltTyp: Provable<V>
Returns V
- Defined in src/lib/store/mongo_store.ts:140

`Protected` valueToStr

valueToStr(value: V): string
Protected
Serialize the value of the FieldElements type into a string

Returns
{string}

Memberof
RocksStore
Parameters
- value: V
Returns string
- Defined in src/lib/store/mongo_store.ts:166

Generated using TypeDoc