Class ProvendbStore

constructor

• new ProvendbStore(options?: ProvendbStoreOptions): ProvendbStore

  Parameters

  • options: ProvendbStoreOptions = {}

  Returns ProvendbStore

Readonlyname

Readonlylibrary

connect

• connect(): Promise<void>

  Returns Promise<void>

disconnect

• disconnect(): Promise<void>

  Returns Promise<void>

isConnected

• isConnected(): boolean

  Returns boolean

getClient

• getClient(): ProvendbHttpClient

  Returns the underlying (internal or injected) HTTP client.

  Returns ProvendbHttpClient

append

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

  Insert data into collection at a new version (POST /collections/<c>/documents). Returns the inserted document (including its _id and _version).

  Parameters

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

  Returns Promise<unknown>

get

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

  Read the current version of document id from collection.

  Parameters

  • collection: string
  • id: string

  Returns Promise<unknown>

history

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

  Return every version of document id (GET .../documents/<id>/versions).

  Parameters

  • collection: string
  • id: string

  Returns Promise<unknown>

verify

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

  Request a cryptographic proof for document id (POST .../documents/<id>/proof). The returned object contains the Merkle proof and the public-blockchain anchor that tamper-proofs the document's state at its version.

  Parameters

  • collection: string
  • id: string

  Returns Promise<unknown>

query

• query(
      collection: string,
      query?: Record<string, unknown>,
      options?: Record<string, unknown>,
  ): Promise<unknown>

  Run a Mongo-style filter query against collection (POST /collections/<c>/query). query is the Mongo filter document; options carries projection/sort/limit and an optional historical version.

  Parameters

  • collection: string
  • query: Record<string, unknown> = {}
  • Optionaloptions: Record<string, unknown>

  Returns Promise<unknown>

findAll

• findAll<T = Record<string, unknown>>(
      collection: string,
      options?: ProvendbFindOptions,
  ): Promise<T[]>

  Fetch every document in collection matching the ORM where clause. The where is compiled to a MongoDB filter; attributes/order/limit/ offset become the projection/sort/limit/skip query options, and version (if given) reads the collection at a historical ProvenDB version.

  Type Parameters

  • T = Record<string, unknown>

  Parameters

  • collection: string
  • options: ProvendbFindOptions = {}

  Returns Promise<T[]>

findOne

• findOne<T = Record<string, unknown>>(
      collection: string,
      options?: ProvendbFindOptions,
  ): Promise<T | null>

  Fetch the first document matching where (Mongo limit 1), or null.

  Type Parameters

  • T = Record<string, unknown>

  Parameters

  • collection: string
  • options: ProvendbFindOptions = {}

  Returns Promise<T | null>

count

• count(collection: string, where?: Record<string, any>): Promise<number>

  Count documents in collection matching where.

  Parameters

  • collection: string
  • Optionalwhere: Record<string, any>

  Returns Promise<number>

create

• create(collection: string, data: Record<string, unknown>): Promise<unknown>

  Insert data as a new versioned document. Alias of append.

  Parameters

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

  Returns Promise<unknown>

bulkCreate

• bulkCreate(
      collection: string,
      docs: Record<string, unknown>[],
  ): Promise<unknown[]>

  Insert many documents (one versioned write per document), returning them.

  Parameters

  • collection: string
  • docs: Record<string, unknown>[]

  Returns Promise<unknown[]>

update

• update(
      collection: string,
      values: Record<string, unknown>,
      where?: Record<string, any>,
      options?: { upsert?: boolean },
  ): Promise<unknown>

  Update every document matching where, $setting each key in values. Returns the raw ProvenDB response (which records the new version the write was captured at).

  Parameters

  • collection: string
  • values: Record<string, unknown>
  • Optionalwhere: Record<string, any>
  • options: { upsert?: boolean } = {}

  Returns Promise<unknown>

upsert

• upsert(
      collection: string,
      data: Record<string, unknown>,
      where: Record<string, any>,
  ): Promise<unknown>

  Insert-or-update: update documents matching where with data, creating a new document if none match (upsert: true).

  Parameters

  • collection: string
  • data: Record<string, unknown>
  • where: Record<string, any>

  Returns Promise<unknown>

destroy

• destroy(collection: string, where?: Record<string, any>): Promise<unknown>

  Delete every document matching where. ProvenDB retains prior versions, so deleted documents remain recoverable via history.

  Parameters

  • collection: string
  • Optionalwhere: Record<string, any>

  Returns Promise<unknown>