Class Database<DT>

constructor

• new Database<DT extends {} = {}>(name?: string, opts?: ConfigOpts): Database<DT>

• Type Parameters

  • DT extends {} = {}

  Parameters

  • Optionalname: string
  • Optionalopts: ConfigOpts

  Returns Database<DT>

Readonly_crdt

Readonly_listeners

_listening

Readonly_noupdate_listeners

Readonly_ready

Readonly_writeQueue

Readonlyblockstore

Readonlylogger

Optional Readonlyname

Readonlyopts

Readonlysthis

Staticdatabases

_no_update_notify

• _no_update_notify(): Promise<void>

• Returns Promise<void>

_notify

• _notify(updates: DocUpdate<{}>[]): Promise<void>

• Parameters

  • updates: DocUpdate<{}>[]

  Returns Promise<void>

allDocs

• allDocs<T extends {}>(opts?: AllDocsQueryOpts): Promise<AllDocsResponse<T>>

• Type Parameters

  • T extends {}

  Parameters

  • opts: AllDocsQueryOpts = {}

  Returns Promise<AllDocsResponse<T>>

allDocuments

• allDocuments<T extends {}>(): Promise<
      { clock: ClockHead; rows: { key: string; value: DocWithId<T> }[] },
  >

• Type Parameters

  • T extends {}

  Returns Promise<{ clock: ClockHead; rows: { key: string; value: DocWithId<T> }[] }>

changes

• changes<T extends {}>(
      since?: ClockHead,
      opts?: ChangesOptions,
  ): Promise<ChangesResponse<T>>

• Type Parameters

  • T extends {}

  Parameters

  • since: ClockHead = []
  • opts: ChangesOptions = {}

  Returns Promise<ChangesResponse<T>>

close

• close(): Promise<void>

• Close the database and release resources

  Returns Promise<void>

compact

• compact(): Promise<void>

• Returns Promise<void>

del

• del(id: string): Promise<DocResponse>

• delete a document from the database

  Parameters

  • id: string

    Document id

  Returns Promise<DocResponse>

  DocResponse with the id and clock

destroy

• destroy(): Promise<void>

• Destroy the database and release all resources

  Returns Promise<void>

get

• get<T extends {}>(id: string): Promise<DocWithId<T>>

• Get a document from the database

  Type Parameters

  • T extends {}

  Parameters

  • id: string

    the document id

  Returns Promise<DocWithId<T>>

  the document with the _id

  Throws

  NotFoundError if the document is not found

put

• put<T extends {}>(doc: DocSet<T>): Promise<DocResponse>

• Put a document from the database

  Type Parameters

  • T extends {}

  Parameters

  • doc: DocSet<T>

    the document to put

  Returns Promise<DocResponse>

  add DocResponse with the id and clock

query

• query<K extends IndexKeyType, T extends {}, R extends DocFragment = T>(
      field: string | MapFn<T>,
      opts?: QueryOpts<K>,
  ): Promise<IndexRows<K, T, R>>

• Type Parameters

  • K extends IndexKeyType
  • T extends {}
  • R extends DocFragment = T

  Parameters

  • field: string | MapFn<T>
  • opts: QueryOpts<K> = {}

  Returns Promise<IndexRows<K, T, R>>

ready

• ready(): Promise<void>

• Returns Promise<void>

subscribe

• subscribe<T extends {}>(listener: ListenerFn<T>, updates?: boolean): () => void

• Type Parameters

  • T extends {}

  Parameters

  • listener: ListenerFn<T>
  • Optionalupdates: boolean

  Returns () => void