Class TerminusdbStore

constructor

• new TerminusdbStore(options?: TerminusdbStoreOptions): TerminusdbStore

  Parameters

  • options: TerminusdbStoreOptions = {}

  Returns TerminusdbStore

Readonlyname

Readonlylibrary

connect

• connect(): Promise<void>

  Returns Promise<void>

disconnect

• disconnect(): Promise<void>

  Returns Promise<void>

isConnected

• isConnected(): boolean

  Returns boolean

getClient

• getClient(): TerminusClientLike

  Returns the underlying WOQLClient for anything not wrapped here.

  Returns TerminusClientLike

append

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

  Insert data as a new document of type table (a new commit). Returns whatever addDocument reports (typically the inserted document id(s)).

  Parameters

  • table: string
  • data: Record<string, unknown>

  Returns Promise<unknown>

get

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

  Fetch the current revision of document <table>/<id>.

  Parameters

  • table: string
  • id: string

  Returns Promise<unknown>

history

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

  Return the commit history for document <table>/<id> via a WOQL query over the commit graph. Every past revision lives in the immutable commit chain, so this surfaces the document's provenance.

  Parameters

  • table: string
  • id: string

  Returns Promise<unknown>

verify

• verify(
      table: string,
      id: string,
  ): Promise<{ id: string; exists: boolean; document: unknown }>

  Verify document <table>/<id> by reading it back from the immutable store. Returns { id, exists, document } - existence in the commit graph is the provenance guarantee (TerminusDB never mutates past commits).

  Parameters

  • table: string
  • id: string

  Returns Promise<{ id: string; exists: boolean; document: unknown }>

query

• query(woql: unknown, commitMsg?: string): Promise<unknown>

  Run a raw WOQL query object.

  Parameters

  • woql: unknown
  • OptionalcommitMsg: string

  Returns Promise<unknown>