Class Collection

Exposes the operations which are available to be performed against a collection. Namely the ability to perform KV operations.

Index

Accessors

name

get name(): string
The name of the collection this Collection object references.

Returns string
- Defined in lib/collection.ts:669

Methods

binary

binary(): BinaryCollection
Returns a BinaryCollection object reference, allowing access to various binary operations possible against a collection.

Returns BinaryCollection
- Defined in lib/collection.ts:2214

exists

exists(
    key: string,
    options?: ExistsOptions,
    callback?: NodeCallback<ExistsResult>,
): Promise<ExistsResult>
Checks whether a specific document exists or not.
Parameters
- key: string
  The document key to check for existence.
- Optionaloptions: ExistsOptions
  Optional parameters for this operation.
- Optionalcallback: NodeCallback<ExistsResult>
  A node-style callback to be invoked after execution.
Returns Promise<ExistsResult>
- Defined in lib/collection.ts:827

get

get(
    key: string,
    options?: GetOptions,
    callback?: NodeCallback<GetResult>,
): Promise<GetResult>
Retrieves the value of a document from the collection.
Parameters
- key: string
  The document key to retrieve.
- Optionaloptions: GetOptions
  Optional parameters for this operation.
- Optionalcallback: NodeCallback<GetResult>
  A node-style callback to be invoked after execution.
Returns Promise<GetResult>
- Defined in lib/collection.ts:680

getAllReplicas

getAllReplicas(
    key: string,
    options?: GetAllReplicasOptions,
    callback?: NodeCallback<GetReplicaResult[]>,
): Promise<GetReplicaResult[]>
Retrieves the value of the document from all available replicas. Note that as replication is asynchronous, each node may return a different value.
Parameters
- key: string
  The document key to retrieve.
- Optionaloptions: GetAllReplicasOptions
  Optional parameters for this operation.
- Optionalcallback: NodeCallback<GetReplicaResult[]>
  A node-style callback to be invoked after execution.
Returns Promise<GetReplicaResult[]>
- Defined in lib/collection.ts:1028

getAndLock

getAndLock(
    key: string,
    lockTime: number,
    options?: GetAndLockOptions,
    callback?: NodeCallback<GetResult>,
): Promise<GetResult>
Locks a document and retrieves the value of that document at the time it is locked.
Parameters
- key: string
  The document key to retrieve and lock.
- lockTime: number
  The amount of time to lock the document for, specified in seconds.
- Optionaloptions: GetAndLockOptions
  Optional parameters for this operation.
- Optionalcallback: NodeCallback<GetResult>
  A node-style callback to be invoked after execution.
Returns Promise<GetResult>
- Defined in lib/collection.ts:1494

getAndTouch

getAndTouch(
    key: string,
    expiry: number,
    options?: GetAndTouchOptions,
    callback?: NodeCallback<GetResult>,
): Promise<GetResult>
Retrieves the value of the document and simultanously updates the expiry time for the same document.
Parameters
- key: string
  The document to fetch and touch.
- expiry: number
  The new expiry to apply to the document, specified in seconds.
- Optionaloptions: GetAndTouchOptions
  Optional parameters for this operation.
- Optionalcallback: NodeCallback<GetResult>
  A node-style callback to be invoked after execution.
Returns Promise<GetResult>
- Defined in lib/collection.ts:1381

getAnyReplica

getAnyReplica(
    key: string,
    options?: GetAnyReplicaOptions,
    callback?: NodeCallback<GetReplicaResult>,
): Promise<GetReplicaResult>
Retrieves the value of the document from any of the available replicas. This will return as soon as the first response is received from any replica node.
Parameters
- key: string
  The document key to retrieve.
- Optionaloptions: GetAnyReplicaOptions
  Optional parameters for this operation.
- Optionalcallback: NodeCallback<GetReplicaResult>
  A node-style callback to be invoked after execution.
Returns Promise<GetReplicaResult>
- Defined in lib/collection.ts:1005

insert

insert(
    key: string,
    value: any,
    options?: InsertOptions,
    callback?: NodeCallback<MutationResult>,
): Promise<MutationResult>
Inserts a new document to the collection, failing if the document already exists.
Parameters
- key: string
  The document key to insert.
- value: any
  The value of the document to insert.
- Optionaloptions: InsertOptions
  Optional parameters for this operation.
- Optionalcallback: NodeCallback<MutationResult>
  A node-style callback to be invoked after execution.
Returns Promise<MutationResult>
- Defined in lib/collection.ts:1044

list

list(key: string): CouchbaseList
Returns a CouchbaseList permitting simple list storage in a document.
Parameters
- key: string
  The document key the data-structure resides in.
Returns CouchbaseList
- Defined in lib/collection.ts:2179

lookupIn

lookupIn(
    key: string,
    specs: LookupInSpec[],
    options?: LookupInOptions,
    callback?: NodeCallback<LookupInResult>,
): Promise<LookupInResult>
Performs a lookup-in operation against a document, fetching individual fields or information about specific fields inside the document value.
Parameters
- key: string
  The document key to look in.
- specs: LookupInSpec[]
  A list of specs describing the data to fetch from the document.
- Optionaloptions: LookupInOptions
  Optional parameters for this operation.
- Optionalcallback: NodeCallback<LookupInResult>
  A node-style callback to be invoked after execution.
Returns Promise<LookupInResult>
- Defined in lib/collection.ts:1760

lookupInAllReplicas

lookupInAllReplicas(
    key: string,
    specs: LookupInSpec[],
    options?: LookupInAllReplicasOptions,
    callback?: NodeCallback<LookupInReplicaResult[]>,
): Promise<LookupInReplicaResult[]>
Performs a lookup-in operation against a document, fetching individual fields or information about specific fields inside the document value from all available replicas. Note that as replication is asynchronous, each node may return a different value.
Parameters
- key: string
  The document key to look in.
- specs: LookupInSpec[]
  A list of specs describing the data to fetch from the document.
- Optionaloptions: LookupInAllReplicasOptions
  Optional parameters for this operation.
- Optionalcallback: NodeCallback<LookupInReplicaResult[]>
  A node-style callback to be invoked after execution.
Returns Promise<LookupInReplicaResult[]>
- Defined in lib/collection.ts:2036

lookupInAnyReplica

lookupInAnyReplica(
    key: string,
    specs: LookupInSpec[],
    options?: LookupInAnyReplicaOptions,
    callback?: NodeCallback<LookupInReplicaResult>,
): Promise<LookupInReplicaResult>
Performs a lookup-in operation against a document, fetching individual fields or information about specific fields inside the document value from any of the available replicas in the cluster.
Parameters
- key: string
  The document key to look in.
- specs: LookupInSpec[]
  A list of specs describing the data to fetch from the document.
- Optionaloptions: LookupInAnyReplicaOptions
  Optional parameters for this operation.
- Optionalcallback: NodeCallback<LookupInReplicaResult>
  A node-style callback to be invoked after execution.
Returns Promise<LookupInReplicaResult>
- Defined in lib/collection.ts:2010

map

map(key: string): CouchbaseMap
Returns a CouchbaseMap permitting simple map storage in a document.
Parameters
- key: string
  The document key the data-structure resides in.
Returns CouchbaseMap
- Defined in lib/collection.ts:2197

mutateIn

mutateIn(
    key: string,
    specs: MutateInSpec[],
    options?: MutateInOptions,
    callback?: NodeCallback<MutateInResult>,
): Promise<MutateInResult>
Performs a mutate-in operation against a document. Allowing atomic modification of specific fields within a document. Also enables access to document extended-attributes.
Parameters
- key: string
  The document key to mutate.
- specs: MutateInSpec[]
  A list of specs describing the operations to perform on the document.
- Optionaloptions: MutateInOptions
  Optional parameters for this operation.
- Optionalcallback: NodeCallback<MutateInResult>
  A node-style callback to be invoked after execution.
Returns Promise<MutateInResult>
- Defined in lib/collection.ts:2054

queryIndexes

queryIndexes(): CollectionQueryIndexManager
Returns a CollectionQueryIndexManager which can be used to manage the query indexes of this collection.

Returns CollectionQueryIndexManager
- Defined in lib/collection.ts:2524

queue

queue(key: string): CouchbaseQueue
Returns a CouchbaseQueue permitting simple queue storage in a document.
Parameters
- key: string
  The document key the data-structure resides in.
Returns CouchbaseQueue
- Defined in lib/collection.ts:2188

remove

remove(
    key: string,
    options?: RemoveOptions,
    callback?: NodeCallback<MutationResult>,
): Promise<MutationResult>
Remove an existing document from the collection.
Parameters
- key: string
  The document key to remove.
- Optionaloptions: RemoveOptions
  Optional parameters for this operation.
- Optionalcallback: NodeCallback<MutationResult>
  A node-style callback to be invoked after execution.
Returns Promise<MutationResult>
- Defined in lib/collection.ts:1305

replace

replace(
    key: string,
    value: any,
    options?: ReplaceOptions,
    callback?: NodeCallback<MutationResult>,
): Promise<MutationResult>
Replaces the value of an existing document. Failing if the document does not exist.
Parameters
- key: string
  The document key to replace.
- value: any
  The new value for the document.
- Optionaloptions: ReplaceOptions
  Optional parameters for this operation.
- Optionalcallback: NodeCallback<MutationResult>
  A node-style callback to be invoked after execution.
Returns Promise<MutationResult>
- Defined in lib/collection.ts:1217

scan

scan(
    scanType: RangeScan | SamplingScan | PrefixScan,
    options?: ScanOptions,
    callback?: NodeCallback<ScanResult[]>,
): Promise<ScanResult[]>
Performs a key-value scan operation.

Use this API for low concurrency batch queries where latency is not a critical as the system may have to scan a lot of documents to find the matching documents. For low latency range queries, it is recommended that you use SQL++ with the necessary indexes.
Parameters
- scanType: RangeScan | SamplingScan | PrefixScan
  The type of scan to execute.
- Optionaloptions: ScanOptions
  Optional parameters for the scan operation.
- Optionalcallback: NodeCallback<ScanResult[]>
  A node-style callback to be invoked after execution.
Returns Promise<ScanResult[]>
- Defined in lib/collection.ts:1707

set

set(key: string): CouchbaseSet
Returns a CouchbaseSet permitting simple set storage in a document.
Parameters
- key: string
  The document key the data-structure resides in.
Returns CouchbaseSet
- Defined in lib/collection.ts:2206

touch

touch(
    key: string,
    expiry: number,
    options?: TouchOptions,
    callback?: NodeCallback<MutationResult>,
): Promise<MutationResult>
Updates the expiry on an existing document.
Parameters
- key: string
  The document key to touch.
- expiry: number
  The new expiry to set for the document, specified in seconds.
- Optionaloptions: TouchOptions
  Optional parameters for this operation.
- Optionalcallback: NodeCallback<MutationResult>
  A node-style callback to be invoked after execution.
Returns Promise<MutationResult>
- Defined in lib/collection.ts:1444

unlock

unlock(
    key: string,
    cas: CasInput,
    options?: UnlockOptions,
    callback?: NodeCallback<void>,
): Promise<void>
Unlocks a previously locked document.
Parameters
- key: string
  The document key to unlock.
- cas: CasInput
  The CAS of the document, used to validate lock ownership.
- Optionaloptions: UnlockOptions
  Optional parameters for this operation.
- Optionalcallback: NodeCallback<void>
  A node-style callback to be invoked after execution.
Returns Promise<void>
- Defined in lib/collection.ts:1557

upsert

upsert(
    key: string,
    value: any,
    options?: UpsertOptions,
    callback?: NodeCallback<MutationResult>,
): Promise<MutationResult>
Upserts a document to the collection. This operation succeeds whether or not the document already exists.
Parameters
- key: string
  The document key to upsert.
- value: any
  The new value for the document.
- Optionaloptions: UpsertOptions
  Optional parameters for this operation.
- Optionalcallback: NodeCallback<MutationResult>
  A node-style callback to be invoked after execution.
Returns Promise<MutationResult>
- Defined in lib/collection.ts:1130

Class Collection

Index

Accessors

Methods

Accessors

name

Returns string

Methods

binary

Returns BinaryCollection

exists

Parameters

Returns Promise<ExistsResult>

get

Parameters

Returns Promise<GetResult>

getAllReplicas

Parameters

Returns Promise<GetReplicaResult[]>

getAndLock

Parameters

Returns Promise<GetResult>

getAndTouch

Parameters

Returns Promise<GetResult>

getAnyReplica

Parameters

Returns Promise<GetReplicaResult>

insert

Parameters

Returns Promise<MutationResult>

list

Parameters

Returns CouchbaseList

lookupIn

Parameters

Returns Promise<LookupInResult>

lookupInAllReplicas

Parameters

Returns Promise<LookupInReplicaResult[]>

lookupInAnyReplica

Parameters

Returns Promise<LookupInReplicaResult>

map

Parameters

Returns CouchbaseMap

mutateIn

Parameters

Returns Promise<MutateInResult>

queryIndexes

Returns CollectionQueryIndexManager

queue

Parameters

Returns CouchbaseQueue

remove

Parameters

Returns Promise<MutationResult>

replace

Parameters

Returns Promise<MutationResult>

scan

Parameters

Returns Promise<ScanResult[]>

set

Parameters

Returns CouchbaseSet

touch

Parameters

Returns Promise<MutationResult>

unlock

Parameters

Returns Promise<void>

upsert

Parameters

Returns Promise<MutationResult>

Settings

On This Page