Class DBTransaction

Hierarchy

CreateDestroy
- DBTransaction

Constructors

constructor

new DBTransaction(__namedParameters): DBTransaction
Parameters
- __namedParameters: {
      db: DB;
      lockBox: LockBox<RWLockWriter>;
      locksPending?: Map<string, {
          count: number;
      }>;
      logger?: Logger;
  } & RocksDBPutOptions
Returns DBTransaction
Inherited from CreateDestroy.constructor
- Defined in src/DBTransaction.ts:49

Properties

`Readonly` [initLock]

[initLock]: RWLockWriter

`Protected` _callbacksFailure

_callbacksFailure: ((e?) => any)[] = []

Type declaration

- (e?): any
- Parameters
  - Optional e: Error
  Returns any

`Protected` _callbacksFinally

_callbacksFinally: ((e?) => any)[] = []

Type declaration

- (e?): any
- Parameters
  - Optional e: Error
  Returns any

`Protected` _callbacksSuccess

_callbacksSuccess: (() => any)[] = []

Type declaration

- (): any
- Returns any

`Protected` _committed

_committed: boolean = false

`Protected` _committing

_committing: boolean = false

`Protected` _db

_db: DB

`Protected` _iteratorRefs

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

`Protected` _options

_options: RocksDBPutOptions

`Protected` _rollbacked

_rollbacked: boolean = false

`Protected` _rollbacking

_rollbacking: boolean = false

`Protected` _snapshot

_snapshot: RocksDBTransactionSnapshot

`Protected` _transaction

_transaction: RocksDBTransaction

`Protected` commitOrRollbackLock

commitOrRollbackLock: Lock = ...

`Readonly` id

id: number

`Protected` logger

logger: Logger

`Protected` monitor

monitor: Monitor<RWLockWriter>

Accessors

[destroyed]

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

[eventHandled]

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

[eventHandlers]

get [eventHandlers](): ReadonlyMap<string, Set<EventHandlerInfo>>
Returns ReadonlyMap<string, Set<EventHandlerInfo>>
Inherited from CreateDestroy.[eventHandlers]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:6

[eventTarget]

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

[handleEventError]

get [handleEventError](): ((evt) => void)
Returns ((evt) => void)
- - (evt): void
  - Parameters
    - evt: EventError
    Returns void
Inherited from CreateDestroy.[handleEventError]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:8

[statusP]

get [statusP](): Promise<Status>
Returns Promise<Status>
Inherited from CreateDestroy.[statusP]
- Defined in node_modules/@matrixai/async-init/dist/CreateDestroy.d.ts:8

[status]

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

callbacksFailure

get callbacksFailure(): readonly (() => any)[]
Returns readonly (() => any)[]
- Defined in src/DBTransaction.ts:108

callbacksFinally

get callbacksFinally(): readonly (() => any)[]
Returns readonly (() => any)[]
- Defined in src/DBTransaction.ts:112

callbacksSuccess

get callbacksSuccess(): readonly (() => any)[]
Returns readonly (() => any)[]
- Defined in src/DBTransaction.ts:104

committed

get committed(): boolean
Indicates when the transaction is committed

Returns boolean
- Defined in src/DBTransaction.ts:126

committing

get committing(): boolean
Indicates when this.commit is first called

Returns boolean
- Defined in src/DBTransaction.ts:119

db

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

locks

get locks(): ReadonlyMap<string, {
    status: "acquiring";
    type: "read" | "write";
} | {
    lock: RWLockWriter;
    release: ResourceRelease;
    status: "acquired";
    type: "read" | "write";
}>
Returns ReadonlyMap<string, {
    status: "acquiring";
    type: "read" | "write";
} | {
    lock: RWLockWriter;
    release: ResourceRelease;
    status: "acquired";
    type: "read" | "write";
}>
- Defined in src/DBTransaction.ts:144

rollbacked

get rollbacked(): boolean
Indicates when the transaction is rollbacked

Returns boolean
- Defined in src/DBTransaction.ts:140

rollbacking

get rollbacking(): boolean
Indicates when this.rollback is first called

Returns boolean
- Defined in src/DBTransaction.ts:133

transaction

get transaction(): Readonly<RocksDBTransaction>
Returns Readonly<RocksDBTransaction>
- Defined in src/DBTransaction.ts:100

Methods

addEventListener

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

clear

clear(levelPath?, options?): Promise<void>
Parameters
- levelPath: readonly (string | Buffer)[] = []
- options: DBClearOptions<RocksDBTransactionSnapshot> = {}
Returns Promise<void>
- Defined in src/DBTransaction.ts:323

commit

commit(): Promise<void>
Returns Promise<void>
- Defined in src/DBTransaction.ts:396

count

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

del

del(keyPath): Promise<void>
Parameters
- keyPath: string | Buffer | readonly (string | Buffer)[]
Returns Promise<void>
- Defined in src/DBTransaction.ts:266

destroy

destroy(): Promise<void>
Destroy the transaction This cannot be called until the transaction is committed or rollbacked

Returns Promise<void>
Inherited from CreateDestroy.destroy
- Defined in src/DBTransaction.ts:83

dispatchEvent

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

dump

dump<V>(levelPath?, raw?): Promise<[readonly (string | Buffer)[], V][]>
Dump from transaction level path This will only show entries for the current transaction It is intended for diagnostics
Type Parameters
- V
Parameters
- Optional levelPath: readonly (string | Buffer)[]
- Optional raw: false
Returns Promise<[readonly (string | Buffer)[], V][]>
- Defined in src/DBTransaction.ts:358
dump(levelPath, raw): Promise<[readonly (string | Buffer)[], Buffer][]>
Parameters
- levelPath: undefined | readonly (string | Buffer)[]
- raw: true
Returns Promise<[readonly (string | Buffer)[], Buffer][]>
- Defined in src/DBTransaction.ts:362

get

get<T>(keyPath, raw?): Promise<undefined | T>
Type Parameters
- T
Parameters
- keyPath: string | Buffer | readonly (string | Buffer)[]
- Optional raw: false
Returns Promise<undefined | T>
- Defined in src/DBTransaction.ts:177
get(keyPath, raw): Promise<undefined | Buffer>
Parameters
- keyPath: string | Buffer | readonly (string | Buffer)[]
- raw: true
Returns Promise<undefined | Buffer>
- Defined in src/DBTransaction.ts:181

getForUpdate

getForUpdate<T>(keyPath, raw?): Promise<undefined | T>
Use this for to address write skews
Type Parameters
- T
Parameters
- keyPath: string | Buffer | readonly (string | Buffer)[]
- Optional raw: false
Returns Promise<undefined | T>
- Defined in src/DBTransaction.ts:211
getForUpdate(keyPath, raw): Promise<undefined | Buffer>
Parameters
- keyPath: string | Buffer | readonly (string | Buffer)[]
- raw: true
Returns Promise<undefined | Buffer>
- Defined in src/DBTransaction.ts:215

iterator

iterator(levelPath, options): DBIterator<undefined, undefined>
Parameters
- levelPath: undefined | readonly (string | Buffer)[]
- options: DBIteratorOptions<RocksDBTransactionSnapshot> & {
  keys: false;
  values: false;
  }
Returns DBIterator<undefined, undefined>
- Defined in src/DBTransaction.ts:275
iterator<V>(levelPath, options): DBIterator<undefined, V>
Type Parameters
- V
Parameters
- levelPath: undefined | readonly (string | Buffer)[]
- options: DBIteratorOptions<RocksDBTransactionSnapshot> & {
  keys: false;
  valueAsBuffer: false;
  }
Returns DBIterator<undefined, V>
- Defined in src/DBTransaction.ts:282
iterator(levelPath, options): DBIterator<undefined, Buffer>
Parameters
- levelPath: undefined | readonly (string | Buffer)[]
- options: DBIteratorOptions<RocksDBTransactionSnapshot> & {
  keys: false;
  }
Returns DBIterator<undefined, Buffer>
- Defined in src/DBTransaction.ts:289
iterator(levelPath, options): DBIterator<readonly (string | Buffer)[], undefined>
Parameters
- levelPath: undefined | readonly (string | Buffer)[]
- options: DBIteratorOptions<RocksDBTransactionSnapshot> & {
  values: false;
  }
Returns DBIterator<readonly (string | Buffer)[], undefined>
- Defined in src/DBTransaction.ts:293
iterator<V>(levelPath, options): DBIterator<readonly (string | Buffer)[], V>
Type Parameters
- V
Parameters
- levelPath: undefined | readonly (string | Buffer)[]
- options: DBIteratorOptions<RocksDBTransactionSnapshot> & {
  valueAsBuffer: false;
  }
Returns DBIterator<readonly (string | Buffer)[], V>
- Defined in src/DBTransaction.ts:297
iterator(levelPath?, options?): DBIterator<readonly (string | Buffer)[], Buffer>
Parameters
- Optional levelPath: readonly (string | Buffer)[]
- Optional options: DBIteratorOptions<RocksDBTransactionSnapshot>
Returns DBIterator<readonly (string | Buffer)[], Buffer>
- Defined in src/DBTransaction.ts:303

lock

lock(...params): Promise<void>
Parameters
- Rest ...params: (string | RWLockRequest)[] | [...requests: (string | RWLockRequest)[], ctx: Partial<ContextTimedInput>] | [ctx?: Partial<ContextTimedInput>]
Returns Promise<void>
- Defined in src/DBTransaction.ts:155

put

put(keyPath, value, raw?): Promise<void>
Parameters
- keyPath: string | Buffer | readonly (string | Buffer)[]
- value: any
- Optional raw: false
Returns Promise<void>
- Defined in src/DBTransaction.ts:242
put(keyPath, value, raw): Promise<void>
Parameters
- keyPath: string | Buffer | readonly (string | Buffer)[]
- value: Buffer
- raw: true
Returns Promise<void>
- Defined in src/DBTransaction.ts:247

queueFailure

queueFailure(f): void
Parameters
- f: ((e?) => any)
  - - (e?): any
    - Parameters
      
      Optional e: Error
      
      Returns any
Returns void
- Defined in src/DBTransaction.ts:386

queueFinally

queueFinally(f): void
Parameters
- f: ((e?) => any)
  - - (e?): any
    - Parameters
      
      Optional e: Error
      
      Returns any
Returns void
- Defined in src/DBTransaction.ts:391

queueSuccess

queueSuccess(f): void
Parameters
- f: (() => any)
  - - (): any
    - Returns any
Returns void
- Defined in src/DBTransaction.ts:381

removeEventListener

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

rollback

rollback(e?): Promise<void>
Parameters
- Optional e: Error
Returns Promise<void>
- Defined in src/DBTransaction.ts:443

setSnapshot

setSnapshot(): void
Set the snapshot manually This ensures that consistent reads and writes start after this method is executed This is idempotent Note that normally snapshots are set lazily upon the first transaction db operation

Returns void
- Defined in src/DBTransaction.ts:482

`Protected` setupSnapshot

setupSnapshot(): RocksDBTransactionSnapshot
Sets up the snapshot This is executed lazily, not at this construction, but at the first transactional operation

Returns RocksDBTransactionSnapshot
- Defined in src/DBTransaction.ts:492

unlock

unlock(...params): Promise<void>
Parameters
- Rest ...params: string[]
Returns Promise<void>
- Defined in src/DBTransaction.ts:171

Class DBTransaction

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

__namedParameters: { db: DB; lockBox: LockBox<RWLockWriter>; locksPending?: Map<string, { count: number; }>; logger?: Logger; } & RocksDBPutOptions

Returns DBTransaction

Properties

Readonly [initLock]

Protected _callbacksFailure

Type declaration

Parameters

Optional e: Error

Returns any

Protected _callbacksFinally

Type declaration

Parameters

Optional e: Error

Returns any

Protected _callbacksSuccess

Type declaration

Returns any

Protected _committed

Protected _committing

Protected _db

Protected _iteratorRefs

Protected _options

Protected _rollbacked

Protected _rollbacking

Protected _snapshot

Protected _transaction

Protected commitOrRollbackLock

Readonly id

Protected logger

Protected monitor

Accessors

[destroyed]

Returns boolean

[eventHandled]

Returns ReadonlyWeakSet<Event>

[eventHandlers]

Returns ReadonlyMap<string, Set<EventHandlerInfo>>

[eventTarget]

Returns EventTarget

[handleEventError]

Returns ((evt) => void)

Parameters

evt: EventError

Returns void

[statusP]

Returns Promise<Status>

[status]

Returns Status

callbacksFailure

Returns readonly (() => any)[]

callbacksFinally

Returns readonly (() => any)[]

callbacksSuccess

Returns readonly (() => any)[]

committed

Returns boolean

committing

Returns boolean

db

Returns Readonly<DB>

locks

Returns ReadonlyMap<string, { status: "acquiring"; type: "read" | "write"; } | { lock: RWLockWriter; release: ResourceRelease; status: "acquired"; type: "read" | "write"; }>

rollbacked

Returns boolean

rollbacking

Returns boolean

transaction

Returns Readonly<RocksDBTransaction>

Methods

addEventListener

__namedParameters: {
db: DB;
lockBox: LockBox<RWLockWriter>;
locksPending?: Map<string, {
count: number;
}>;
logger?: Logger;
} & RocksDBPutOptions

`Readonly` [initLock]

`Protected` _callbacksFailure

`Optional` e: Error

`Protected` _callbacksFinally

`Optional` e: Error

`Protected` _callbacksSuccess

`Protected` _committed

`Protected` _committing

`Protected` _db

`Protected` _iteratorRefs

`Protected` _options

`Protected` _rollbacked

`Protected` _rollbacking

`Protected` _snapshot

`Protected` _transaction

`Protected` commitOrRollbackLock

`Readonly` id

`Protected` logger

`Protected` monitor

Returns ReadonlyMap<string, {
status: "acquiring";
type: "read" | "write";
} | {
lock: RWLockWriter;
release: ResourceRelease;
status: "acquired";
type: "read" | "write";
}>

`Optional` options: boolean | AddEventListenerOptions

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

`Optional` raw: false

`Optional` raw: false

`Optional` raw: false

options: DBIteratorOptions<RocksDBTransactionSnapshot> & {
keys: false;
values: false;
}

options: DBIteratorOptions<RocksDBTransactionSnapshot> & {
keys: false;
valueAsBuffer: false;
}