Generated using TypeDoc
Dump from transaction level +
LevelDB snapshots can only be accessed via an iterator
+This maintains a consistent read-only snapshot of the DB
+when DBTransaction is constructed
Reading from the snapshot iterator needs to be an atomic operation +involving a synchronus seek and asynchronous next
+Dump from transaction level path +This will only show entries for the current transaction It is intended for diagnostics
-Generated using TypeDoc
Get value from the snapshot iterator +This is an atomic operation +It will seek to the key path and await the next entry +If the entry's key equals the desired key, the entry is returned
+Generated using TypeDoc
Causation of the exception Can be used to know what caused this exception
Optional override for formatting stack traces
Encoding to JSON pojo
-When overriding this, you can use super.toJSON
super.toJSON
+The replacer will:
+Create .stack property on a target object
Optional override for formatting stack traces
Encoding to JSON pojo
-When overriding this, you can use super.toJSON
super.toJSON
+The replacer will:
+Create .stack property on a target object
Optional override for formatting stack traces
Encoding to JSON pojo
-When overriding this, you can use super.toJSON
super.toJSON
+The replacer will:
+Create .stack property on a target object
Optional override for formatting stack traces
Encoding to JSON pojo
-When overriding this, you can use super.toJSON
super.toJSON
+The replacer will:
+Create .stack property on a target object
Optional override for formatting stack traces
Encoding to JSON pojo
-When overriding this, you can use super.toJSON
super.toJSON
+The replacer will:
+Create .stack property on a target object
Optional override for formatting stack traces
Encoding to JSON pojo
-When overriding this, you can use super.toJSON
super.toJSON
+The replacer will:
+Create .stack property on a target object
Optional override for formatting stack traces
Encoding to JSON pojo
-When overriding this, you can use super.toJSON
super.toJSON
+The replacer will:
+Create .stack property on a target object
Optional override for formatting stack traces
Encoding to JSON pojo
-When overriding this, you can use super.toJSON
super.toJSON
+The replacer will:
+Create .stack property on a target object
Optional override for formatting stack traces
Encoding to JSON pojo
-When overriding this, you can use super.toJSON
super.toJSON
+The replacer will:
+Create .stack property on a target object
Optional override for formatting stack traces
Encoding to JSON pojo
-When overriding this, you can use super.toJSON
super.toJSON
+The replacer will:
+Create .stack property on a target object
Optional override for formatting stack traces
Encoding to JSON pojo
-When overriding this, you can use super.toJSON
super.toJSON
+The replacer will:
+Create .stack property on a target object
Optional override for formatting stack traces
Encoding to JSON pojo
-When overriding this, you can use super.toJSON
super.toJSON
+The replacer will:
+Create .stack property on a target object
Causation of the exception Can be used to know what caused this exception
Optional override for formatting stack traces
Encoding to JSON pojo
-When overriding this, you can use super.toJSON
super.toJSON
+The replacer will:
+Create .stack property on a target object
this in static methods
https://github.com/microsoft/TypeScript/issues/5863
-Generated using TypeDoc
Generated using TypeDoc
Optional override for formatting stack traces
Encoding to JSON pojo
-When overriding this, you can use super.toJSON
super.toJSON
+The replacer will:
+Create .stack property on a target object
Custom type for our iterator This takes over from the outdated AbstractIterator used in abstract-leveldown
-Path to a key This must be an non-empty array
Generated using TypeDoc
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@matrixai/dbClass DB
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Parameters
__namedParameters: { crypto?: { key: Buffer; ops: Crypto }; dbPath: string; fs: FileSystem; logger: Logger }
Optional crypto?: { key: Buffer; ops: Crypto }
key: Buffer
ops: Crypto
db
fs: FileSystem
logger: Logger
Returns DB
Properties
Readonly [init
Protected _db
Protected Optional crypto
Type declaration
key: Buffer
ops: Crypto
Readonly db
Protected fs
Protected logger
Protected transaction
Protected Optional worker
Accessors
[destroyed]
Returns boolean
[running]
Returns boolean
[status]
Returns Status
db
Returns Readonly<LevelDB<string | Buffer, Buffer>>
Methods
batch
Batches operations together atomically
-Parameters
ops: readonly DBOp[]
Returns Promise<void>
Protected canary
Returns Promise<void>
clear
Parameters
ops: readonly DBOp[]
Returns Promise<void>
Protected canary
Returns Promise<void>
clear
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)[] = []
Returns Promise<void>
count
Parameters
levelPath: readonly (string | Buffer)[] = []
Returns Promise<number>
del
Parameters
levelPath: readonly (string | Buffer)[] = []
Returns Promise<void>
count
Parameters
levelPath: readonly (string | Buffer)[] = []
Returns Promise<number>
del
Deletes a key from the DB
-Parameters
keyPath: string | Buffer | readonly (string | Buffer)[]
Returns Promise<void>
deserialize
Type parameters
T
Parameters
cipherTextBuf: Buffer
raw: false
Returns Promise<T>
Parameters
cipherTextBuf: Buffer
raw: true
Returns Promise<Buffer>
destroy
Returns Promise<void>
dump
Dump from root level +
Parameters
keyPath: string | Buffer | readonly (string | Buffer)[]
Returns Promise<void>
deserialize
Type parameters
T
Parameters
cipherTextBuf: Buffer
raw: false
Returns Promise<T>
Parameters
cipherTextBuf: Buffer
raw: true
Returns Promise<Buffer>
destroy
Returns Promise<void>
dump
Dump from root level path +This will show entries from all levels It is intended for diagnostics
-Parameters
Optional levelPath: readonly (string | Buffer)[]
Optional raw: false
Returns Promise<[string, any][]>
Parameters
levelPath: undefined | readonly (string | Buffer)[]
raw: true
Returns Promise<[Buffer, Buffer][]>
get
Type parameters
V
Parameters
Optional levelPath: readonly (string | Buffer)[]
Optional raw: false
Returns Promise<[string, V][]>
Parameters
levelPath: undefined | readonly (string | Buffer)[]
raw: true
Returns Promise<[Buffer, Buffer][]>
get
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>
Parameters
keyPath: string | Buffer | readonly (string | Buffer)[]
raw: true
Returns Promise<undefined | Buffer>
iterator
Type parameters
T
Parameters
keyPath: string | Buffer | readonly (string | Buffer)[]
Optional raw: false
Returns Promise<undefined | T>
Parameters
keyPath: string | Buffer | readonly (string | Buffer)[]
raw: true
Returns Promise<undefined | Buffer>
iterator
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
options: AbstractIteratorOptions<any> & { keys: false; values: false }
Optional levelPath: readonly (string | Buffer)[]
Returns DBIterator<undefined, undefined>
Parameters
options: AbstractIteratorOptions<any> & { keys: false }
Optional levelPath: readonly (string | Buffer)[]
Returns DBIterator<undefined, Buffer>
Parameters
options: AbstractIteratorOptions<any> & { values: false }
Optional levelPath: readonly (string | Buffer)[]
Returns DBIterator<Buffer, undefined>
Parameters
Optional options: AbstractIteratorOptions<any>
Optional levelPath: readonly (string | Buffer)[]
Returns DBIterator<Buffer, Buffer>
put
Parameters
options: AbstractIteratorOptions<any> & { keys: false; values: false }
Optional levelPath: readonly (string | Buffer)[]
Returns DBIterator<undefined, undefined>
Parameters
options: AbstractIteratorOptions<any> & { keyAsBuffer?: true; values: false }
Optional levelPath: readonly (string | Buffer)[]
Returns DBIterator<Buffer, undefined>
Parameters
options: AbstractIteratorOptions<any> & { keyAsBuffer: false; values: false }
Optional levelPath: readonly (string | Buffer)[]
Returns DBIterator<string, undefined>
Parameters
options: AbstractIteratorOptions<any> & { keys: false; valueAsBuffer?: true }
Optional levelPath: readonly (string | Buffer)[]
Returns DBIterator<undefined, Buffer>
Type parameters
V
Parameters
options: AbstractIteratorOptions<any> & { keys: false; valueAsBuffer: false }
Optional levelPath: readonly (string | Buffer)[]
Returns DBIterator<undefined, V>
Parameters
Optional options: AbstractIteratorOptions<any> & { keyAsBuffer?: true; valueAsBuffer?: true }
Optional levelPath: readonly (string | Buffer)[]
Returns DBIterator<Buffer, Buffer>
Parameters
Optional options: AbstractIteratorOptions<any> & { keyAsBuffer: false; valueAsBuffer?: true }
Optional levelPath: readonly (string | Buffer)[]
Returns DBIterator<string, Buffer>
Type parameters
V
Parameters
Optional options: AbstractIteratorOptions<any> & { keyAsBuffer?: true; valueAsBuffer: false }
Optional levelPath: readonly (string | Buffer)[]
Returns DBIterator<Buffer, V>
Type parameters
V
Parameters
Optional options: AbstractIteratorOptions<any> & { keyAsBuffer: false; valueAsBuffer: false }
Optional levelPath: readonly (string | Buffer)[]
Returns DBIterator<string, V>
put
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
Returns Promise<void>
Parameters
keyPath: string | Buffer | readonly (string | Buffer)[]
value: Buffer
raw: true
Returns Promise<void>
serialize
Parameters
value: any
raw: false
Returns Promise<Buffer>
Parameters
value: Buffer
raw: true
Returns Promise<Buffer>
set
Parameters
workerManager: DBWorkerManagerInterface
Returns void
Protected setup
Parameters
dbPath: string
Returns Promise<LevelDB<string | Buffer, Buffer>>
Protected setup
Returns Promise<void>
start
Parameters
__namedParameters: { fresh?: boolean } = {}
Optional fresh?: boolean
Returns Promise<void>
stop
Returns Promise<void>
transaction
Returns ResourceAcquire<DBTransaction>
unset
Returns void
with
Type parameters
T
Parameters
f: (tran: DBTransaction) => Promise<T>
Parameters
tran: DBTransaction
Returns Promise<T>
Returns Promise<T>
with
Type parameters
T
TReturn
TNext
Parameters
g: (tran: DBTransaction) => AsyncGenerator<T, TReturn, TNext>
Parameters
tran: DBTransaction
Returns AsyncGenerator<T, TReturn, TNext>
Returns AsyncGenerator<T, TReturn, TNext>
Static createDB
Parameters
__namedParameters: { crypto?: { canary?: Buffer; key: Buffer; ops: Crypto }; dbPath: string; fresh?: boolean; fs?: FileSystem; logger?: Logger }
Optional crypto?: { canary?: Buffer; key: Buffer; ops: Crypto }
Optional canary?: Buffer
key: Buffer
ops: Crypto
db
Optional fresh?: boolean
Optional fs?: FileSystem
Optional logger?: Logger
Returns Promise<DB>
Generated using TypeDoc