Class ImmudbStore

constructor

• new ImmudbStore(options?: ImmudbStoreOptions): ImmudbStore

  Parameters

  • options: ImmudbStoreOptions = {}

  Returns ImmudbStore

Readonlyname

Readonlylibrary

connect

• connect(): Promise<void>

  Returns Promise<void>

disconnect

• disconnect(): Promise<void>

  Returns Promise<void>

isConnected

• isConnected(): boolean

  Returns boolean

getClient

• getClient(): ImmudbClientLike

  Returns the underlying immudb-node client for anything not wrapped here.

  Returns ImmudbClientLike

append

• append(table: string, data: unknown): Promise<string>

  Append data under the key <table>:<data.id> (or <table> if data has no id) via a verified, tamper-evident write. Returns the write's transaction id/hash from immudb's response.

  Parameters

  • table: string
  • data: unknown

  Returns Promise<string>

get

• get(table: string, id?: string): Promise<unknown>

  Verified read of the current value at <table>:<id> (or <table>).

  Parameters

  • table: string
  • Optionalid: string

  Returns Promise<unknown>

history

• history(table: string, id?: string): Promise<unknown>

  Return every prior revision of the key <table>:<id> (or <table>).

  Parameters

  • table: string
  • Optionalid: string

  Returns Promise<unknown>

verify

• verify(table: string, id?: string): Promise<unknown>

  Verified read returning the full response - value plus the cryptographic inclusion proof immudb generates for verifiedGet. The presence of a resolved response (rather than a thrown verification error) is the proof that the value is consistent with the tamper-evident log.

  Parameters

  • table: string
  • Optionalid: string

  Returns Promise<unknown>

query

• query(statement: string, params?: unknown): Promise<unknown>

  Run a SQL statement against immudb's embedded SQL engine (sqlQuery).

  Parameters

  • statement: string
  • Optionalparams: unknown

  Returns Promise<unknown>

exec

• exec(statement: string, params?: unknown): Promise<unknown>

  Execute a SQL DDL/DML statement via sqlExec (no rows returned).

  Parameters

  • statement: string
  • Optionalparams: unknown

  Returns Promise<unknown>