Class CouchbaseStore

constructor

• new CouchbaseStore(options?: CouchbaseStoreOptions): CouchbaseStore

  Parameters

  • options: CouchbaseStoreOptions = {}

  Returns CouchbaseStore

Readonlyname

Readonlylibrary

connect

• connect(): Promise<void>

  Returns Promise<void>

disconnect

• disconnect(): Promise<void>

  Returns Promise<void>

isConnected

• isConnected(): boolean

  Returns boolean

getClient

• getClient(): any

  Returns the underlying native Cluster for anything not wrapped here.

  Returns any

collection

• collection(bucket?: string, scope?: string, collection?: string): any

  Resolves a collection handle. With no arguments (or only a bucket) it uses the store's configured defaults; passing an explicit scope/collection targets a non-default collection via bucket.scope(scope).collection(collection), otherwise it falls back to bucket.defaultCollection().

  Parameters

  • Optionalbucket: string
  • Optionalscope: string
  • Optionalcollection: string

  Returns any

insert

• insert(id: string, doc: unknown): Promise<unknown>

  Insert a new document; fails if the key already exists.

  Parameters

  • id: string
  • doc: unknown

  Returns Promise<unknown>

upsert

• upsert(id: string, doc: unknown): Promise<unknown>

  Insert or replace a document by key.

  Parameters

  • id: string
  • doc: unknown

  Returns Promise<unknown>

get

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

  Fetch a document by key, returning its .content (the stored value).

  Parameters

  • id: string

  Returns Promise<unknown>

replace

• replace(id: string, doc: unknown): Promise<unknown>

  Replace an existing document; fails if the key does not exist.

  Parameters

  • id: string
  • doc: unknown

  Returns Promise<unknown>

remove

• remove(id: string): Promise<unknown>

  Remove a document by key.

  Parameters

  • id: string

  Returns Promise<unknown>

query

• query(statement: string, options?: CouchbaseQueryOptions): Promise<unknown[]>

  Run a N1QL/SQL++ statement against the cluster and return its result rows. options.parameters binds positional (array) or named (object) parameters into the statement.

  Parameters

  • statement: string
  • options: CouchbaseQueryOptions = {}

  Returns Promise<unknown[]>