Class DB

Hierarchy

CreateDestroyStartStop
- DB

Constructors

constructor

new DB(__namedParameters): DB
Parameters
- __namedParameters: {
      dbPath: string;
      deadlock: boolean;
      fs: FileSystem;
      logger: Logger;
  }
  - dbPath: string
  - deadlock: boolean
  - fs: FileSystem
  - logger: Logger
Returns DB
Inherited from CreateDestroyStartStop.constructor
- Defined in src/DB.ts:114

Properties

`Readonly` [initLock]

[initLock]: RWLockWriter

`Protected` _db

_db: RocksDBDatabase

`Protected` _iteratorRefs

_iteratorRefs: Set<DBIterator<any, any>> = ...

References to iterators

`Protected` _lockBox

_lockBox: LockBox<RWLockWriter> = ...

`Protected` `Optional` _locksPending

_locksPending?: Map<string, {
count: number;
}>

Type declaration

count: number

`Protected` _transactionRefs

_transactionRefs: Set<DBTransaction> = ...

References to transactions

`Protected` `Optional` crypto

crypto?: {
key: Buffer;
ops: Crypto;
}

Type declaration

key: Buffer
ops: Crypto

`Readonly` dbPath

dbPath: string

`Protected` fs

fs: FileSystem

`Protected` logger

logger: Logger

`Protected` `Optional` workerManager

workerManager?: DBWorkerManagerInterface

Accessors

[destroyed]

get [destroyed](): boolean
Returns boolean
Inherited from CreateDestroyStartStop.[destroyed]
- Defined in node_modules/@matrixai/async-init/dist/CreateDestroyStartStop.d.ts:7

[eventHandled]

get [eventHandled](): WeakSet<Event>
Returns WeakSet<Event>
Inherited from CreateDestroyStartStop.[eventHandled]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:5

[eventHandlers]

get [eventHandlers](): WeakMap<EventListenerOrEventListenerObject, EventListener>
Returns WeakMap<EventListenerOrEventListenerObject, EventListener>
Inherited from CreateDestroyStartStop.[eventHandlers]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:4

[eventTarget]

get [eventTarget](): EventTarget
Returns EventTarget
Inherited from CreateDestroyStartStop.[eventTarget]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:3

[running]

get [running](): boolean
Returns boolean
Inherited from CreateDestroyStartStop.[running]
- Defined in node_modules/@matrixai/async-init/dist/CreateDestroyStartStop.d.ts:6

[status]

get [status](): Status
Returns Status
Inherited from CreateDestroyStartStop.[status]
- Defined in node_modules/@matrixai/async-init/dist/CreateDestroyStartStop.d.ts:8

db

get db(): Readonly<RocksDBDatabase>
Returns Readonly<RocksDBDatabase>
- Defined in src/DB.ts:92

lockBox

get lockBox(): Readonly<LockBox<RWLockWriter>>
Returns Readonly<LockBox<RWLockWriter>>
- Defined in src/DB.ts:110

Methods

addEventListener

addEventListener(type, callback, options?): void
Parameters
- type: string
- callback: null | EventListenerOrEventListenerObject
- Optional options: boolean | AddEventListenerOptions
Returns void
Inherited from CreateDestroyStartStop.addEventListener
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:6

batch

batch(ops, sync?): Promise<void>
Batches operations together atomically
Parameters
- ops: readonly DBOp[]
- sync: boolean = false
Returns Promise<void>
- Defined in src/DB.ts:393

`Protected` canaryCheck

canaryCheck(): Promise<void>
Returns Promise<void>
- Defined in src/DB.ts:738

clear

clear(levelPath?, options?): Promise<void>
Clear all key values for a specific level This is not atomic, it will iterate over a snapshot of the DB
Parameters
- levelPath: readonly (string | Buffer)[] = []
- options: DBClearOptions = {}
Returns Promise<void>
- Defined in src/DB.ts:559

count

count(levelPath?, options?): Promise<number>
Parameters
- levelPath: readonly (string | Buffer)[] = []
- options: DBCountOptions = {}
Returns Promise<number>
- Defined in src/DB.ts:580

del

del(keyPath, sync?): Promise<void>
Deletes a key from the DB
Parameters
- keyPath: string | Buffer | readonly (string | Buffer)[]
- sync: boolean = false
Returns Promise<void>
- Defined in src/DB.ts:370

deserializeDecrypt

deserializeDecrypt<T>(cipherTextBuf, raw): Promise<T>
Type Parameters
- T
Parameters
- cipherTextBuf: Buffer
- raw: false
Returns Promise<T>
- Defined in src/DB.ts:671
deserializeDecrypt(cipherTextBuf, raw): Promise<Buffer>
Parameters
- cipherTextBuf: Buffer
- raw: true
Returns Promise<Buffer>
- Defined in src/DB.ts:675

destroy

destroy(): Promise<void>
Returns Promise<void>
Inherited from CreateDestroyStartStop.destroy
- Defined in src/DB.ts:198

dispatchEvent

dispatchEvent(event): boolean
Parameters
- event: Event
Returns boolean
Inherited from CreateDestroyStartStop.dispatchEvent
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:8

dump

dump<V>(levelPath?, raw?, root?): Promise<[readonly (string | Buffer)[], V][]>
Dump from DB This will show entries from all levels It is intended for diagnostics Use console.dir instead of console.log to debug the result Set root to true if you want to dump from root levels
Type Parameters
- V
Parameters
- Optional levelPath: readonly (string | Buffer)[]
- Optional raw: false
- Optional root: boolean
Returns Promise<[readonly (string | Buffer)[], V][]>
- Defined in src/DB.ts:608
dump(levelPath, raw, root?): Promise<[readonly (string | Buffer)[], Buffer][]>
Parameters
- levelPath: undefined | readonly (string | Buffer)[]
- raw: true
- Optional root: boolean
Returns Promise<[readonly (string | Buffer)[], Buffer][]>
- Defined in src/DB.ts:613

get

get<T>(keyPath, raw?): Promise<undefined | T>
Gets a value from the DB Use raw to return the raw decrypted buffer
Type Parameters
- T
Parameters
- keyPath: string | Buffer | readonly (string | Buffer)[]
- Optional raw: false
Returns Promise<undefined | T>
- Defined in src/DB.ts:264
get(keyPath, raw): Promise<undefined | Buffer>
Parameters
- keyPath: string | Buffer | readonly (string | Buffer)[]
- raw: true
Returns Promise<undefined | Buffer>
- Defined in src/DB.ts:268

iterator

iterator(levelPath, options): DBIterator<undefined, undefined>
Public iterator that works from the data level If keys and values are both false, this iterator will not run at all You must have at least one of them being true or undefined
Parameters
- levelPath: undefined | readonly (string | Buffer)[]
- options: DBIteratorOptions & {
  keys: false;
  values: false;
  }
Returns DBIterator<undefined, undefined>
- Defined in src/DB.ts:464
iterator<V>(levelPath, options): DBIterator<undefined, V>
Type Parameters
- V
Parameters
- levelPath: undefined | readonly (string | Buffer)[]
- options: DBIteratorOptions & {
  keys: false;
  valueAsBuffer: false;
  }
Returns DBIterator<undefined, V>
- Defined in src/DB.ts:468
iterator(levelPath, options): DBIterator<undefined, Buffer>
Parameters
- levelPath: undefined | readonly (string | Buffer)[]
- options: DBIteratorOptions & {
  keys: false;
  }
Returns DBIterator<undefined, Buffer>
- Defined in src/DB.ts:472
iterator(levelPath, options): DBIterator<readonly (string | Buffer)[], undefined>
Parameters
- levelPath: undefined | readonly (string | Buffer)[]
- options: DBIteratorOptions & {
  values: false;
  }
Returns DBIterator<readonly (string | Buffer)[], undefined>
- Defined in src/DB.ts:476
iterator<V>(levelPath, options): DBIterator<readonly (string | Buffer)[], V>
Type Parameters
- V
Parameters
- levelPath: undefined | readonly (string | Buffer)[]
- options: DBIteratorOptions & {
  valueAsBuffer: false;
  }
Returns DBIterator<readonly (string | Buffer)[], V>
- Defined in src/DB.ts:480
iterator(levelPath?, options?): DBIterator<readonly (string | Buffer)[], Buffer>
Parameters
- Optional levelPath: readonly (string | Buffer)[]
- Optional options: DBIteratorOptions
Returns DBIterator<readonly (string | Buffer)[], Buffer>
- Defined in src/DB.ts:484

put

put(keyPath, value, raw?, sync?): Promise<void>
Put a key and value into the DB Use raw to put raw encrypted buffer
Parameters
- keyPath: string | Buffer | readonly (string | Buffer)[]
- value: any
- Optional raw: false
- Optional sync: boolean
Returns Promise<void>
- Defined in src/DB.ts:312
put(keyPath, value, raw, sync?): Promise<void>
Parameters
- keyPath: string | Buffer | readonly (string | Buffer)[]
- value: Buffer
- raw: true
- Optional sync: boolean
Returns Promise<void>
- Defined in src/DB.ts:318

removeEventListener

removeEventListener(type, callback, options?): void
Parameters
- type: string
- callback: null | EventListenerOrEventListenerObject
- Optional options: boolean | EventListenerOptions
Returns void
Inherited from CreateDestroyStartStop.removeEventListener
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:7

serializeEncrypt

serializeEncrypt(value, raw): Promise<Buffer>
Parameters
- value: any
- raw: false
Returns Promise<Buffer>
- Defined in src/DB.ts:637
serializeEncrypt(value, raw): Promise<Buffer>
Parameters
- value: Buffer
- raw: true
Returns Promise<Buffer>
- Defined in src/DB.ts:638

setWorkerManager

setWorkerManager(workerManager): void
Parameters
- workerManager: DBWorkerManagerInterface
Returns void
- Defined in src/DB.ts:211

`Protected` setupDb

setupDb(dbPath, options?): Promise<RocksDBDatabase>
Parameters
- dbPath: string
- options: RocksDBDatabaseOptions = {}
Returns Promise<RocksDBDatabase>
- Defined in src/DB.ts:712

`Protected` setupRootLevels

setupRootLevels(): Promise<void>
Returns Promise<void>
- Defined in src/DB.ts:734

start

start(__namedParameters?): Promise<void>
Parameters
- __namedParameters: {
      crypto?: {
          key: Buffer;
          ops: Crypto;
      };
      fresh?: boolean;
  } & DBOptions = {}
Returns Promise<void>
Inherited from CreateDestroyStartStop.start
- Defined in src/DB.ts:133

stop

stop(): Promise<void>
Returns Promise<void>
Inherited from CreateDestroyStartStop.stop
- Defined in src/DB.ts:177

transaction

transaction(): ResourceAcquire<DBTransaction>
Returns ResourceAcquire<DBTransaction>
- Defined in src/DB.ts:219

unsetWorkerManager

unsetWorkerManager(): void
Returns void
- Defined in src/DB.ts:215

withTransactionF

withTransactionF<T>(f): Promise<T>
Type Parameters
- T
Parameters
- f: ((tran) => Promise<T>)
  - - (tran): Promise<T>
    - Parameters
      
      tran: DBTransaction
      
      Returns Promise<T>
Returns Promise<T>
- Defined in src/DB.ts:248

withTransactionG

withTransactionG<T, TReturn, TNext>(g): AsyncGenerator<T, TReturn, TNext>
Type Parameters
- T
- TReturn
- TNext
Parameters
- g: ((tran) => AsyncGenerator<T, TReturn, TNext>)
  - - (tran): AsyncGenerator<T, TReturn, TNext>
    - Parameters
      
      tran: DBTransaction
      
      Returns AsyncGenerator<T, TReturn, TNext>
Returns AsyncGenerator<T, TReturn, TNext>
- Defined in src/DB.ts:254

`Static` createDB

createDB(__namedParameters): Promise<DB>
Parameters
- __namedParameters: {
      crypto?: {
          key: Buffer;
          ops: Crypto;
      };
      dbPath: string;
      deadlock?: boolean;
      fresh?: boolean;
      fs?: FileSystem;
      logger?: Logger;
  } & DBOptions
Returns Promise<DB>
- Defined in src/DB.ts:37

Class DB

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

__namedParameters: { dbPath: string; deadlock: boolean; fs: FileSystem; logger: Logger; }

dbPath: string

deadlock: boolean

fs: FileSystem

logger: Logger

Returns DB

Properties

Readonly [initLock]

Protected _db

Protected _iteratorRefs

Protected _lockBox

Protected Optional _locksPending

Type declaration

count: number

Protected _transactionRefs

Protected Optional crypto

Type declaration

key: Buffer

ops: Crypto

Readonly dbPath

Protected fs

Protected logger

Protected Optional workerManager

Accessors

[destroyed]

Returns boolean

[eventHandled]

Returns WeakSet<Event>

[eventHandlers]

Returns WeakMap<EventListenerOrEventListenerObject, EventListener>

[eventTarget]

Returns EventTarget

[running]

Returns boolean

[status]

Returns Status

db

Returns Readonly<RocksDBDatabase>

lockBox

Returns Readonly<LockBox<RWLockWriter>>

Methods

addEventListener

Parameters

type: string

callback: null | EventListenerOrEventListenerObject

Optional options: boolean | AddEventListenerOptions

Returns void

batch

Parameters

ops: readonly DBOp[]

sync: boolean = false

Returns Promise<void>

Protected canaryCheck

Returns Promise<void>

clear

Parameters

levelPath: readonly (string | Buffer)[] = []

options: DBClearOptions = {}

Returns Promise<void>

count

Parameters

levelPath: readonly (string | Buffer)[] = []

options: DBCountOptions = {}

Returns Promise<number>

del

Parameters

keyPath: string | Buffer | readonly (string | Buffer)[]

sync: boolean = false

Returns Promise<void>

deserializeDecrypt

__namedParameters: {
dbPath: string;
deadlock: boolean;
fs: FileSystem;
logger: Logger;
}

`Readonly` [initLock]

`Protected` _db

`Protected` _iteratorRefs

`Protected` _lockBox

`Protected` `Optional` _locksPending

`Protected` _transactionRefs

`Protected` `Optional` crypto

`Readonly` dbPath

`Protected` fs

`Protected` logger

`Protected` `Optional` workerManager

`Optional` options: boolean | AddEventListenerOptions

`Protected` canaryCheck

`Optional` levelPath: readonly (string | Buffer)[]

`Optional` raw: false

`Optional` root: boolean

`Optional` root: boolean

`Optional` raw: false

options: DBIteratorOptions & {
keys: false;
values: false;
}

options: DBIteratorOptions & {
keys: false;
valueAsBuffer: false;
}

options: DBIteratorOptions & {
keys: false;
}

options: DBIteratorOptions & {
values: false;
}

options: DBIteratorOptions & {
valueAsBuffer: false;
}

`Optional` levelPath: readonly (string | Buffer)[]

`Optional` options: DBIteratorOptions