API Documentation

Class

Collection

Collection

Collection provides an interface for performing operations against a collection within the cluster.

View Source collection.js, line 40

Methods

# binary() → {BinaryCollection}

View Source collection.js, line 1191

Never

BinaryCollection

# async exists(key, optionsopt, callbackopt) → {Promise.<ExistsResult>}

Parameters:
Name Type Attributes Description
key string
options * <optional>
timeout integer <optional>
callback ExistsCallback <optional>

View Source collection.js, line 354

Promise.<ExistsResult>

# async get(key, optionsopt, callbackopt) → {Promise.<GetResult>}

Parameters:
Name Type Attributes Default Description
key string
options * <optional>
project Array.<string> <optional>
withExpiry boolean <optional>
 false
transcoder Transcoder <optional>
timeout integer <optional>
callback GetCallback <optional>

View Source collection.js, line 202

Promise.<GetResult>

# async getAllReplicas(key, optionsopt, callbackopt) → {Promise.<Array.<GetReplicaResult>>}

Parameters:
Name Type Attributes Description
key string
options * <optional>
transcoder Transcoder <optional>
timeout integer <optional>
callback GetAllReplicasCallback <optional>

View Source collection.js, line 478

Promise.<Array.<GetReplicaResult>>

# async getAndLock(key, lockTime, optionsopt, callbackopt) → {Promise.<GetAndLockCallback>}

Parameters:
Name Type Attributes Description
key string
lockTime integer
options * <optional>
transcoder Transcoder <optional>
timeout integer <optional>
callback GetAndLockCallback <optional>

View Source collection.js, line 807

Promise.<GetAndLockCallback>

# async getAndTouch(key, expiry, optionsopt, callbackopt) → {Promise.<GetAndTouchResult>}

Parameters:
Name Type Attributes Description
key string
expiry integer
options * <optional>
transcoder Transcoder <optional>
timeout integer <optional>
callback GetAndTouchCallback <optional>

View Source collection.js, line 685

Promise.<GetAndTouchResult>

# async getAnyReplica(key, optionsopt, callbackopt) → {Promise.<GetReplicaResult>}

Parameters:
Name Type Attributes Description
key string
options * <optional>
transcoder Transcoder <optional>
timeout integer <optional>
callback GetAnyReplicaCallback <optional>

View Source collection.js, line 455

Promise.<GetReplicaResult>

# async insert(key, value, options, callback) → {Promise.<MutationResult>}

Parameters:
Name Type Attributes Description
key string
value *
options *
transcoder Transcoder <optional>
timeout integer <optional>
callback MutationCallback

View Source collection.js, line 565

CouchbaseError
Promise.<MutationResult>

# list(key) → {CouchbaseList}

Parameters:
Name Type Description
key string

View Source collection.js, line 1149

Never

CouchbaseList

# async lookupIn(key, spec, optionsopt, callbackopt) → {Promise.<LookupInResult>}

Parameters:
Name Type Attributes Description
key string
spec Array.<LookupInSpec>
options * <optional>
timeout integer <optional>
callback LookupInCallback <optional>

View Source collection.js, line 989

Promise.<LookupInResult>

# map(key) → {CouchbaseMap}

Parameters:
Name Type Description
key string

View Source collection.js, line 1171

Never

CouchbaseMap

# async mutateIn(key, spec, optionsopt, callbackopt) → {Promise.<MutateInResult>}

Parameters:
Name Type Attributes Description
key string
spec MutateInSpec
options * <optional>
cas Cas <optional>
timeout integer <optional>
callback MutateInCallback <optional>

View Source collection.js, line 1075

Promise.<MutateInResult>

# queue(key) → {CouchbaseQueue}

Parameters:
Name Type Description
key string

View Source collection.js, line 1160

Never

CouchbaseQueue

# async remove(key, options, callbackopt) → {Promise.<RemoveResult>}

Parameters:
Name Type Attributes Description
key string
options *
timeout integer <optional>
callback RemoveCallback <optional>

View Source collection.js, line 622

Promise.<RemoveResult>

# async replace(key, value, options, callback) → {Promise.<MutationResult>}

Parameters:
Name Type Attributes Description
key string
value *
options *
transcoder Transcoder <optional>
timeout integer <optional>
cas Cas <optional>
callback MutationCallback

View Source collection.js, line 596

CouchbaseError
Promise.<MutationResult>

# set(key) → {CouchbaseSet}

Parameters:
Name Type Description
key string

View Source collection.js, line 1182

Never

CouchbaseSet

# async touch(key, expiry, optionsopt, callbackopt) → {Promise.<TouchResult>}

Parameters:
Name Type Attributes Description
key string
expiry integer
options * <optional>
timeout integer <optional>
callback TouchCallback <optional>

View Source collection.js, line 744

Promise.<TouchResult>

# async unlock(key, cas, optionsopt, callbackopt) → {Promise.<UnlockResult>}

Parameters:
Name Type Attributes Description
key string
cas Cas
options * <optional>
timeout integer <optional>
callback UnlockCallback <optional>

View Source collection.js, line 867

Promise.<UnlockResult>

# async upsert(key, value, optionsopt, callback) → {Promise.<MutationResult>}

Parameters:
Name Type Attributes Description
key string
value *
options * <optional>
transcoder Transcoder <optional>
timeout integer <optional>
callback MutationCallback

View Source collection.js, line 580

CouchbaseError
Promise.<MutationResult>