Clear all key values for a specific level
diff --git a/docs/classes/DBTransaction.html b/docs/classes/DBTransaction.html
index 744bbcf8..b733f1c3 100644
--- a/docs/classes/DBTransaction.html
+++ b/docs/classes/DBTransaction.html
@@ -1,4 +1,4 @@
-
\ No newline at end of file
diff --git a/docs/classes/errors.ErrorDB.html b/docs/classes/errors.ErrorDB.html
index cf5d6d0d..9ae73534 100644
--- a/docs/classes/errors.ErrorDB.html
+++ b/docs/classes/errors.ErrorDB.html
@@ -10,9 +10,14 @@
Static description
description:string = 'DB error'
StaticOptional prepareStackTrace
prepareStackTrace?:(err: Error, stackTraces: CallSite[]) => any
- 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
Clear all key values for a specific level diff --git a/docs/classes/DBTransaction.html b/docs/classes/DBTransaction.html index 744bbcf8..b733f1c3 100644 --- a/docs/classes/DBTransaction.html +++ b/docs/classes/DBTransaction.html @@ -1,4 +1,4 @@ -
- Preparing search index...
- The search index is not available
@matrixai/dbClass DBTransaction
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Parameters
__namedParameters: { db: DB; logger: Logger; transactionId: number }
db: DB
logger: Logger
transaction
Returns DBTransaction
Properties
Readonly [init
Protected _callbacks
Protected _callbacks
Protected _callbacks
Protected _committed
Protected _ops
Protected _rollbacked
Protected db
Protected logger
Readonly transaction
Readonly transaction
Readonly transaction
Readonly transaction
Accessors
[destroyed]
Returns boolean
[status]
Returns Status
callbacks
Returns readonly (() => any)[]
callbacks
Returns readonly (() => any)[]
committed
Returns boolean
ops
Returns readonly DBOp[]
rollbacked
Returns boolean
Methods
clear
Parameters
levelPath: readonly (string | Buffer)[] = []
Returns Promise<void>
commit
Returns Promise<void>
count
Parameters
levelPath: readonly (string | Buffer)[] = []
Returns Promise<number>
del
Parameters
keyPath: string | Buffer | readonly (string | Buffer)[]
Returns Promise<void>
destroy
Returns Promise<void>
dump
- Preparing search index...
- The search index is not available
@matrixai/dbClass DBTransaction
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Parameters
__namedParameters: { db: DB; logger: Logger; transactionId: number }
db: DB
logger: Logger
transaction
Returns DBTransaction
Properties
Readonly [init
Protected _callbacks
Protected _callbacks
Protected _callbacks
Protected _committed
Protected _ops
Protected _rollbacked
Protected db
Protected logger
Readonly transaction
Readonly transaction
Readonly transaction
Readonly transaction
Accessors
[destroyed]
Returns boolean
[status]
Returns Status
callbacks
Returns readonly (() => any)[]
callbacks
Returns readonly (() => any)[]
committed
Returns boolean
ops
Returns readonly DBOp[]
rollbacked
Returns boolean
Methods
clear
Parameters
levelPath: readonly (string | Buffer)[] = []
Returns Promise<void>
commit
Returns Promise<void>
count
Parameters
levelPath: readonly (string | Buffer)[] = []
Returns Promise<number>
del
Parameters
keyPath: string | Buffer | readonly (string | Buffer)[]
Returns Promise<void>
destroy
Returns Promise<void>
dump
Dump from transaction level 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][]>
finalize
Returns Promise<void>
get
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
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
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>
queue
Parameters
f: (e?: Error) => any
Parameters
Optional e: Error
Returns any
Returns void
queue
Parameters
f: (e?: Error) => any
Parameters
Optional e: Error
Returns any
Returns void
queue
Parameters
f: () => any
Returns any
Returns void
rollback
Parameters
Optional e: Error
Returns Promise<void>
Static create
Parameters
__namedParameters: { db: DB; logger?: Logger; transactionId: number }
db: DB
Optional logger?: Logger
transaction
Returns Promise<DBTransaction>
Generated using TypeDoc
Static description
Static Optional prepare
Type declaration
Optional override for formatting stack traces
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
-Parameters
err: Error
stackTraces: CallSite[]
Returns any
Static stack
Accessors
description
Returns string
Methods
toJSON
Parameters
err: Error
stackTraces: CallSite[]
Returns any
Static stack
Accessors
description
Returns string
Methods
toJSON
Encoding to JSON pojo -When overriding this, you can use
+When overriding this, you can usesuper.toJSONsuper.toJSON+Thereplacerwill: ++- delete undefined values in objects
+- replace undefined values for null in arrays
+
Returns any
Static capture
Create .stack property on a target object
Parameters
targetObject: object
Optional constructorOpt: Function
Returns void
Static fromJSON
Static description
Static Optional prepare
Type declaration
Optional override for formatting stack traces
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
-Parameters
err: Error
stackTraces: CallSite[]
Returns any
Static stack
Accessors
description
Returns string
Methods
toJSON
Parameters
err: Error
stackTraces: CallSite[]
Returns any
Static stack
Accessors
description
Returns string
Methods
toJSON
Encoding to JSON pojo -When overriding this, you can use
+When overriding this, you can usesuper.toJSONsuper.toJSON+Thereplacerwill: ++- delete undefined values in objects
+- replace undefined values for null in arrays
+
Returns any
Static capture
Create .stack property on a target object
Parameters
targetObject: object
Optional constructorOpt: Function
Returns void
Static fromJSON
Static description
Static Optional prepare
Type declaration
Optional override for formatting stack traces
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
-Parameters
err: Error
stackTraces: CallSite[]
Returns any
Static stack
Accessors
description
Returns string
Methods
toJSON
Parameters
err: Error
stackTraces: CallSite[]
Returns any
Static stack
Accessors
description
Returns string
Methods
toJSON
Encoding to JSON pojo -When overriding this, you can use
+When overriding this, you can usesuper.toJSONsuper.toJSON+Thereplacerwill: ++- delete undefined values in objects
+- replace undefined values for null in arrays
+
Returns any
Static capture
Create .stack property on a target object
Parameters
targetObject: object
Optional constructorOpt: Function
Returns void
Static fromJSON
Static description
Static Optional prepare
Type declaration
Optional override for formatting stack traces
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
-Parameters
err: Error
stackTraces: CallSite[]
Returns any
Static stack
Accessors
description
Returns string
Methods
toJSON
Parameters
err: Error
stackTraces: CallSite[]
Returns any
Static stack
Accessors
description
Returns string
Methods
toJSON
Encoding to JSON pojo -When overriding this, you can use
+When overriding this, you can usesuper.toJSONsuper.toJSON+Thereplacerwill: ++- delete undefined values in objects
+- replace undefined values for null in arrays
+
Returns any
Static capture
Create .stack property on a target object
Parameters
targetObject: object
Optional constructorOpt: Function
Returns void
Static fromJSON
Static description
Static Optional prepare
Type declaration
Optional override for formatting stack traces
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
-Parameters
err: Error
stackTraces: CallSite[]
Returns any
Static stack
Accessors
description
Returns string
Methods
toJSON
Parameters
err: Error
stackTraces: CallSite[]
Returns any
Static stack
Accessors
description
Returns string
Methods
toJSON
Encoding to JSON pojo -When overriding this, you can use
+When overriding this, you can usesuper.toJSONsuper.toJSON+Thereplacerwill: ++- delete undefined values in objects
+- replace undefined values for null in arrays
+
Returns any
Static capture
Create .stack property on a target object
Parameters
targetObject: object
Optional constructorOpt: Function
Returns void
Static fromJSON
Static description
Static Optional prepare
Type declaration
Optional override for formatting stack traces
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
-Parameters
err: Error
stackTraces: CallSite[]
Returns any
Static stack
Accessors
description
Returns string
Methods
toJSON
Parameters
err: Error
stackTraces: CallSite[]
Returns any
Static stack
Accessors
description
Returns string
Methods
toJSON
Encoding to JSON pojo -When overriding this, you can use
+When overriding this, you can usesuper.toJSONsuper.toJSON+Thereplacerwill: ++- delete undefined values in objects
+- replace undefined values for null in arrays
+
Returns any
Static capture
Create .stack property on a target object
Parameters
targetObject: object
Optional constructorOpt: Function
Returns void
Static fromJSON
Static description
Static Optional prepare
Type declaration
Optional override for formatting stack traces
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
-Parameters
err: Error
stackTraces: CallSite[]
Returns any
Static stack
Accessors
description
Returns string
Methods
toJSON
Parameters
err: Error
stackTraces: CallSite[]
Returns any
Static stack
Accessors
description
Returns string
Methods
toJSON
Encoding to JSON pojo -When overriding this, you can use
+When overriding this, you can usesuper.toJSONsuper.toJSON+Thereplacerwill: ++- delete undefined values in objects
+- replace undefined values for null in arrays
+
Returns any
Static capture
Create .stack property on a target object
Parameters
targetObject: object
Optional constructorOpt: Function
Returns void
Static fromJSON
Static description
Static Optional prepare
Type declaration
Optional override for formatting stack traces
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
-Parameters
err: Error
stackTraces: CallSite[]
Returns any
Static stack
Accessors
description
Returns string
Methods
toJSON
Parameters
err: Error
stackTraces: CallSite[]
Returns any
Static stack
Accessors
description
Returns string
Methods
toJSON
Encoding to JSON pojo -When overriding this, you can use
+When overriding this, you can usesuper.toJSONsuper.toJSON+Thereplacerwill: ++- delete undefined values in objects
+- replace undefined values for null in arrays
+
Returns any
Static capture
Create .stack property on a target object
Parameters
targetObject: object
Optional constructorOpt: Function
Returns void
Static fromJSON
Static description
Static Optional prepare
Type declaration
Optional override for formatting stack traces
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
-Parameters
err: Error
stackTraces: CallSite[]
Returns any
Static stack
Accessors
description
Returns string
Methods
toJSON
Parameters
err: Error
stackTraces: CallSite[]
Returns any
Static stack
Accessors
description
Returns string
Methods
toJSON
Encoding to JSON pojo -When overriding this, you can use
+When overriding this, you can usesuper.toJSONsuper.toJSON+Thereplacerwill: ++- delete undefined values in objects
+- replace undefined values for null in arrays
+
Returns any
Static capture
Create .stack property on a target object
Parameters
targetObject: object
Optional constructorOpt: Function
Returns void
Static fromJSON
Static description
Static desription
Static Optional prepare
Type declaration
Optional override for formatting stack traces
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
-Parameters
err: Error
stackTraces: CallSite[]
Returns any
Static stack
Accessors
description
Returns string
Methods
toJSON
Parameters
err: Error
stackTraces: CallSite[]
Returns any
Static stack
Accessors
description
Returns string
Methods
toJSON
Encoding to JSON pojo -When overriding this, you can use
+When overriding this, you can usesuper.toJSONsuper.toJSON+Thereplacerwill: ++- delete undefined values in objects
+- replace undefined values for null in arrays
+
Returns any
Static capture
Create .stack property on a target object
Parameters
targetObject: object
Optional constructorOpt: Function
Returns void
Static fromJSON
Static description
Static Optional prepare
Type declaration
Optional override for formatting stack traces
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
-Parameters
err: Error
stackTraces: CallSite[]
Returns any
Static stack
Accessors
description
Returns string
Methods
toJSON
Parameters
err: Error
stackTraces: CallSite[]
Returns any
Static stack
Accessors
description
Returns string
Methods
toJSON
Encoding to JSON pojo -When overriding this, you can use
+When overriding this, you can usesuper.toJSONsuper.toJSON+Thereplacerwill: ++- delete undefined values in objects
+- replace undefined values for null in arrays
+
Returns any
Static capture
Create .stack property on a target object
Parameters
targetObject: object
Optional constructorOpt: Function
Returns void
Static fromJSON
Static description
Static Optional prepare
Type declaration
Optional override for formatting stack traces
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
-Parameters
err: Error
stackTraces: CallSite[]
Returns any
Static stack
Accessors
description
Returns string
Methods
toJSON
Parameters
err: Error
stackTraces: CallSite[]
Returns any
Static stack
Accessors
description
Returns string
Methods
toJSON
Encoding to JSON pojo -When overriding this, you can use
+When overriding this, you can usesuper.toJSONsuper.toJSON+Thereplacerwill: ++- delete undefined values in objects
+- replace undefined values for null in arrays
+
Returns any
Static capture
Create .stack property on a target object
Parameters
targetObject: object
Optional constructorOpt: Function
Returns void
Static fromJSON
Static description
Static Optional prepare
Type declaration
Optional override for formatting stack traces
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
-Parameters
err: Error
stackTraces: CallSite[]
Returns any
Static stack
Accessors
description
Returns string
Methods
toJSON
Parameters
err: Error
stackTraces: CallSite[]
Returns any
Static stack
Accessors
description
Returns string
Methods
toJSON
Encoding to JSON pojo -When overriding this, you can use
+When overriding this, you can usesuper.toJSONsuper.toJSON+Thereplacerwill: ++- delete undefined values in objects
+- replace undefined values for null in arrays
+
Returns any
Static capture
Create .stack property on a target object
Parameters
targetObject: object
Optional constructorOpt: Function
Returns void
Static fromJSON
Static description
Static Optional prepare
Type declaration
Optional override for formatting stack traces
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
-Parameters
err: Error
stackTraces: CallSite[]
Returns any
Static stack
Accessors
description
Returns string
Methods
toJSON
Parameters
err: Error
stackTraces: CallSite[]
Returns any
Static stack
Accessors
description
Returns string
Methods
toJSON
Encoding to JSON pojo -When overriding this, you can use
+When overriding this, you can usesuper.toJSONsuper.toJSON+Thereplacerwill: ++- delete undefined values in objects
+- replace undefined values for null in arrays
+
Returns any
Static capture
Create .stack property on a target object
Parameters
targetObject: object
Optional constructorOpt: Function
Returns void
Static fromJSON