API Documentation

Title

Global

Members

string

# constant AnalyticsScanConsistency

Properties:
Name Type Description
NotBounded string
RequestPlus string

View Source enums.js, line 108

string

# constant AnalyticsStatus

Properties:
Name Type Description
Running string
Success string
Errors string
Completed string
Stopped string
Timeout string
Closed string
Fatal string
Aborted string
Unknown string

View Source enums.js, line 118

string

# constant BucketType

Properties:
Name Type Description
Couchbase string
Memcached string
Ephemeral string

View Source enums.js, line 21

string

# constant CompressionMode

Properties:
Name Type Description
Off string
Passive string
Active string

View Source enums.js, line 46

string

# constant ConflictResolutionType

Properties:
Name Type Description
Timestamp string
SequenceNumber string

View Source enums.js, line 59

number

# constant DurabilityLevel

Properties:
Name Type Description
None number
Majority number
MajorityAndPersistOnMaster number
PersistToMajority number

View Source enums.js, line 7

string

# constant EvictionPolicy

Properties:
Name Type Description
FullEviction string
ValueOnly string

View Source enums.js, line 34

string

# constant HighlightStyle

Properties:
Name Type Description
HTML string
ANSI string

View Source enums.js, line 147

string

# constant IndexType

Properties:
Name Type Description
Gsi string
View string
Unknown string

View Source enums.js, line 136

string

# lcbVersion

Expose the LCB version that is in use.

View Source couchbase.js, line 69

string

# constant QueryProfileMode

Properties:
Name Type Description
Off string
Phases string
Timings string

View Source enums.js, line 69

string

# constant QueryScanConsistency

Properties:
Name Type Description
NotBounded string
RequestPlus string

View Source enums.js, line 80

string

# constant QueryStatus

Properties:
Name Type Description
Running string
Success string
Errors string
Completed string
Stopped string
Timeout string
Closed string
Fatal string
Aborted string
Unknown string

View Source enums.js, line 90

string

# constant ViewScanConsistency

Properties:
Name Type Description
RequestPlus string
UpdateAfter string
NotBounded string

View Source enums.js, line 157

Methods

# connect(connStr, optionsopt, callbackopt) → {Promise.<Cluster>}

Creates a new Cluster object for interacting with a Couchbase cluster and performing operations.

Parameters:
Name Type Attributes Description
connStr string

The connection string of your cluster
options Object <optional>
username number <optional>

The RBAC username to use when connecting to the cluster.
password string <optional>

The RBAC password to use when connecting to the cluster
clientCertificate string <optional>

A client certificate to use for authentication with the server. Specifying this certificate along with any other authentication method (such as username and password) is an error.
certificateChain string <optional>

A certificate chain to use for validating the clusters certificates.
callback ConnectCallback <optional>

View Source couchbase.js, line 60

Promise.<Cluster>

Type Definitions

# AllowQueryingCallback(err, res)

Parameters:
Name Type Description
err Error
res boolean

View Source searchindexmanager.js, line 337

Object

# AnalyticsDataset

Properties:
Name Type Description
name string
dataverseName string
linkName string
bucketName string

View Source analyticsindexmanager.js, line 258

Object

# AnalyticsIndex

Properties:
Name Type Description
name string
datasetName string
dataverseName string
isPrimary boolean

View Source analyticsindexmanager.js, line 437

# AnalyticsQueryCallback(err, res)

Parameters:
Name Type Description
err Error
res AnalyticsResult

View Source cluster.js, line 305

Object

# AnalyticsResult

Properties:
Name Type Description
rows Array.<Object>
meta *

View Source cluster.js, line 299

# AnalyzeDocumentCallback(err, res)

Parameters:
Name Type Description
err Error
res Array.<Object>

View Source searchindexmanager.js, line 463

# AppendCallback(err, res)

Parameters:
Name Type Description
err Error
res AppendResult

View Source binarycollection.js, line 77

Object

# AppendResult

Properties:
Name Type Attributes Description
cas Cas
mutationToken MutationToken <optional>

View Source binarycollection.js, line 71

Object

# BucketSettings

BucketSettings provides information about a specific bucket.

Properties:
Name Type Description
name string
flushEnabled boolean
ramQuotaMB number
numReplicas number
replicaIndexes boolean
bucketType BucketType
ejectionMethod EvictionPolicy
maxTTL number
compressionMode CompressionMode

View Source bucketmanager.js, line 26

# BuildDeferredIndexesCallback(err, res)

Parameters:
Name Type Description
err Error
res Array.<string>

View Source queryindexmanager.js, line 344

Object

# CollectionSpec

Properties:
Name Type Description
name string

The name of the collection to create.
scopeName string

The name of the scope to create the collection in.
maxExpiry number

The maximum expiry for documents in this bucket.

View Source collectionmanager.js, line 25

# ConnectCallback(err, cluster)

Parameters:
Name Type Description
err Error
cluster Cluster

View Source couchbase.js, line 34

# ConnectLinkCallback(err, success)

Parameters:
Name Type Description
err Error
success boolean

View Source analyticsindexmanager.js, line 491

# CreateAnalyticsIndexCallback(err, success)

Parameters:
Name Type Description
err Error
success boolean

View Source analyticsindexmanager.js, line 312

# CreateBucketCallback(err, res)

Parameters:
Name Type Description
err Error
res boolean

View Source bucketmanager.js, line 50

Object

# CreateBucketSettings

CreateBucketSettings provides information for creating a bucket.

Properties:
Name Type Description
conflictResolutionType ConflictResolutionType

View Source bucketmanager.js, line 42

# CreateCollectionCallback(err, res)

Parameters:
Name Type Description
err Error
res boolean

View Source collectionmanager.js, line 33

# CreateDatasetCallback(err, success)

Parameters:
Name Type Description
err Error
success boolean

View Source analyticsindexmanager.js, line 133

# CreateDataverseCallback(err, success)

Parameters:
Name Type Description
err Error
success boolean

View Source analyticsindexmanager.js, line 25

# CreatePrimaryIndexCallback(err, res)

Parameters:
Name Type Description
err Error
res boolean

View Source queryindexmanager.js, line 149

# CreateQueryIndexCallback(err, res)

Parameters:
Name Type Description
err Error
res boolean

View Source queryindexmanager.js, line 108

# CreateScopeCallback(err, res)

Parameters:
Name Type Description
err Error
res boolean

View Source collectionmanager.js, line 161

# DecrementCallback(err, res)

Parameters:
Name Type Description
err Error
res DecrementResult

View Source binarycollection.js, line 50

Object

# DecrementResult

Properties:
Name Type Attributes Description
value number
cas Cas
mutationToken MutationToken <optional>

View Source binarycollection.js, line 43

# DiagnosticsCallback(err, res)

Parameters:
Name Type Description
err Error
res DiagnosticsResult

View Source cluster.js, line 143

# DiagnosticsCallback(err, res)

Parameters:
Name Type Description
err Error
res QueryResult

View Source cluster.js, line 234

Object

# DiagnosticsResult

Contains the results from a previously executed Diagnostics operation.

Properties:
Name Type Description
id string
version number
sdk string
services *

View Source cluster.js, line 133

# DisallowQueryingCallback(err, res)

Parameters:
Name Type Description
err Error
res boolean

View Source searchindexmanager.js, line 379

# DisconnectLinkCallback(err, success)

Parameters:
Name Type Description
err Error
success boolean

View Source analyticsindexmanager.js, line 527

# DropAnalyticsIndexCallback(err, success)

Parameters:
Name Type Description
err Error
success boolean

View Source analyticsindexmanager.js, line 384

# DropBucketCallback(err, res)

Parameters:
Name Type Description
err Error
res boolean

View Source bucketmanager.js, line 152

# DropCollectionCallback(err, res)

Parameters:
Name Type Description
err Error
res boolean

View Source collectionmanager.js, line 108

# DropDatasetCallback(err, success)

Parameters:
Name Type Description
err Error
success boolean

View Source analyticsindexmanager.js, line 199

# DropDataverseCallback(err, success)

Parameters:
Name Type Description
err Error
success boolean

View Source analyticsindexmanager.js, line 79

# DropDesignDocumentCallback(err, res)

Parameters:
Name Type Description
err Error
res boolean

View Source viewindexmanager.js, line 188

# DropGroupCallback(err, res)

Parameters:
Name Type Description
err Error
res boolean

View Source usermanager.js, line 790

# DropPrimaryIndexCallback(err, res)

Parameters:
Name Type Description
err Error
res boolean

View Source queryindexmanager.js, line 253

# DropQueryIndexCallback(err, res)

Parameters:
Name Type Description
err Error
res boolean

View Source queryindexmanager.js, line 216

# DropScopeCallback(err, res)

Parameters:
Name Type Description
err Error
res boolean

View Source collectionmanager.js, line 216

# DropSearchIndexCallback(err, res)

Parameters:
Name Type Description
err Error
res boolean

View Source searchindexmanager.js, line 169

# DropUserCallback(err, res)

Parameters:
Name Type Description
err Error
res boolean

View Source usermanager.js, line 536

# ExistsCallback(err, res)

Parameters:
Name Type Description
err Error
res ExistsResult

View Source collection.js, line 368

Object

# ExistsResult

Contains the results from a previously execute Get operation.

Properties:
Name Type Description
exists boolean
cas Cas

View Source collection.js, line 360

# FlushBucketCallback(err, res)

Parameters:
Name Type Description
err Error
res boolean

View Source bucketmanager.js, line 292

# FreezePlanCallback(err, res)

Parameters:
Name Type Description
err Error
res boolean

View Source searchindexmanager.js, line 421

# GetAllBucketsCallback(err, res)

Parameters:
Name Type Description
err Error
res Array.<BucketSettings>

View Source bucketmanager.js, line 250

# GetAllDatasetsCallback(err, datasets)

Parameters:
Name Type Description
err Error
datasets Array.<AnalyticsDataset>

View Source analyticsindexmanager.js, line 266

# GetAllDesignDocumentsCallback(err, res)

Parameters:
Name Type Description
err Error
res Array.<DesignDocument>

View Source viewindexmanager.js, line 27

# GetAllGroupsCallback(err, res)

Parameters:
Name Type Description
err Error
res Array.<Group>

View Source usermanager.js, line 688

# GetAllIndexesCallback(err, indexes)

Parameters:
Name Type Description
err Error
indexes Array.<AnalyticsIndex>

View Source analyticsindexmanager.js, line 445

# GetAllIndexesCallback(err, res)

Parameters:
Name Type Description
err Error
res Array.<QueryIndex>

View Source queryindexmanager.js, line 300

# GetAllReplicasCallback(err, res)

Parameters:
Name Type Description
err Error
res Array.<GetReplicaResult>

View Source collection.js, line 508

# GetAllSearchIndexesCallback(err, res)

Parameters:
Name Type Description
err Error
res Array.<SearchIndex>

View Source searchindexmanager.js, line 83

# GetAllUsersCallback(err, res)

Parameters:
Name Type Description
err Error
res Array.<User>

View Source usermanager.js, line 422

# GetAndLockCallback(err, res)

Parameters:
Name Type Description
err Error
res Array.<GetAndLockResult>

View Source collection.js, line 867

Object

# GetAndLockResult

Properties:
Name Type Attributes Description
content *
cas Cas
mutationToken MutationToken <optional>

View Source collection.js, line 860

# GetAndTouchCallback(err, res)

Parameters:
Name Type Description
err Error
res GetAndTouchResult

View Source collection.js, line 726

Object

# GetAndTouchResult

Properties:
Name Type Attributes Description
content *
cas Cas
mutationToken MutationToken <optional>

View Source collection.js, line 719

# GetAnyReplicaCallback(err, res)

Parameters:
Name Type Description
err Error
res GetReplicaResult

View Source collection.js, line 482

# GetBucketCallback(err, res)

Parameters:
Name Type Description
err Error
res BucketSettings

View Source bucketmanager.js, line 201

# GetCallback(err, res)

Parameters:
Name Type Description
err Error
res GetResult

View Source collection.js, line 189

# GetDesignDocumentCallback(err, res)

Parameters:
Name Type Description
err Error
res DesignDocument

View Source viewindexmanager.js, line 80

# GetGroupCallback(err, res)

Parameters:
Name Type Description
err Error
res Group

View Source usermanager.js, line 639

# GetIndexedDocumentsCountCallback(err, res)

Parameters:
Name Type Description
err Error
res number

View Source searchindexmanager.js, line 211

# GetPendingMutationsCallback(err, pendingMutations)

Parameters:
Name Type Description
err Error
pendingMutations Object.<string, number>

View Source analyticsindexmanager.js, line 563

Object

# GetReplicaResult

Contains the results from a previously executed replica get operation.

Properties:
Name Type Description
value *
cas Cas
isReplica boolean

View Source collection.js, line 473

Object

# GetResult

Contains the results from a previously execute Get operation.

Properties:
Name Type Attributes Description
content *
cas Cas
expiry number <optional>

View Source collection.js, line 180

# GetRolesCallback(err, res)

Parameters:
Name Type Description
err Error
res Array.<RoleAndDescription>

View Source usermanager.js, line 590

# GetSearchIndexCallback(err, res)

Parameters:
Name Type Description
err Error
res SearchIndex

View Source searchindexmanager.js, line 41

# GetUserCallback(err, res)

Parameters:
Name Type Description
err Error
res User

View Source usermanager.js, line 368

# IncrementCallback(err, res)

Parameters:
Name Type Description
err Error
res IncrementResult

View Source binarycollection.js, line 22

Object

# IncrementResult

Properties:
Name Type Attributes Description
value number
cas Cas
mutationToken MutationToken <optional>

View Source binarycollection.js, line 15

# LoggingCallback(entry)

Parameters:
Name Type Description
entry LoggingEntry

View Source connection.js, line 44

Object

# LoggingEntry

Properties:
Name Type Description
severity number
srcFile string
srcLine number
subsys string
message string

View Source connection.js, line 35

# LookupInCallback(err, res)

Parameters:
Name Type Description
err Error
res LookupInResult

View Source collection.js, line 1059

Object

# LookupInResult

Properties:
Name Type Description
content *
cas Cas

View Source collection.js, line 1053

# MutateInCallback(err, res)

Parameters:
Name Type Description
err Error
res MutateInResult

View Source collection.js, line 1148

Object

# MutateInResult

Properties:
Name Type Description
content *

View Source collection.js, line 1143

# MutationCallback(err, res)

Parameters:
Name Type Description
err Error
res MutationResult

View Source collection.js, line 596

Object

# MutationResult

Contains the results from a previously executed mutation operation.

Properties:
Name Type Attributes Description
cas Cas
mutationToken MutationToken <optional>

View Source collection.js, line 586

# PauseIngestCallback(err, res)

Parameters:
Name Type Description
err Error
res boolean

View Source searchindexmanager.js, line 253

# PrependCallback(err, res)

Parameters:
Name Type Description
err Error
res PrependResult

View Source binarycollection.js, line 104

Object

# PrependResult

Properties:
Name Type Attributes Description
cas Cas
mutationToken MutationToken <optional>

View Source binarycollection.js, line 98

# PublishDesignDocumentCallback(err, res)

Parameters:
Name Type Description
err Error
res boolean

View Source viewindexmanager.js, line 239

Object

# QueryIndex

Properties:
Name Type Description
name string
isPrimary boolean
type string
state string
keyspace string
indexKey string

View Source queryindexmanager.js, line 289

Object

# QueryResult

Properties:
Name Type Description
rows Array.<Object>
meta *

View Source cluster.js, line 228

# RemoveCallback(err, res)

Parameters:
Name Type Description
err Error
res RemoveResult

View Source collection.js, line 661

Object

# RemoveResult

Properties:
Name Type Attributes Description
cas Cas
mutationToken MutationToken <optional>

View Source collection.js, line 655

# ResumeIngestCallback(err, res)

Parameters:
Name Type Description
err Error
res boolean

View Source searchindexmanager.js, line 295

Object

# SearchIndex

SearchIndex provides information about a search index.

Properties:
Name Type Description
uuid string
name string
sourceName string
type string
params Object.<string, Object>
sourceUuid string
sourceParams Object.<string, Object>
sourceType string
planParams Object.<string, Object>

View Source searchindexmanager.js, line 25

# SearchQueryCallback(err, res)

Parameters:
Name Type Description
err Error
res SearchQueryResult

View Source cluster.js, line 364

Object

# SearchQueryResult

Properties:
Name Type Description
rows Array.<Object>
meta *

View Source cluster.js, line 358

# TouchCallback(err, res)

Parameters:
Name Type Description
err Error
res TouchResult

View Source collection.js, line 801

Object

# TouchResult

Properties:
Name Type Attributes Description
cas Cas
mutationToken MutationToken <optional>

View Source collection.js, line 795

# UnlockCallback(err, res)

Parameters:
Name Type Description
err Error
res UnlockResult

View Source collection.js, line 932

Object

# UnlockResult

Properties:
Name Type Attributes Description
content *
cas Cas
mutationToken MutationToken <optional>

View Source collection.js, line 925

# UpdateBucketCallback(err, res)

Parameters:
Name Type Description
err Error
res boolean

View Source bucketmanager.js, line 101

# UpsertDesignDocumentCallback(err, res)

Parameters:
Name Type Description
err Error
res boolean

View Source viewindexmanager.js, line 132

# UpsertGroupCallback(err, res)

Parameters:
Name Type Description
err Error
res boolean

View Source usermanager.js, line 738

# UpsertSearchIndexCallback(err, res)

Parameters:
Name Type Description
err Error
res boolean

View Source searchindexmanager.js, line 123

# UpsertUserCallback(err, res)

Parameters:
Name Type Description
err Error
res boolean

View Source usermanager.js, line 478

# ViewQueryCallback(err, res)

Parameters:
Name Type Description
err Error
res ViewQueryResult

View Source bucket.js, line 49

Object

# ViewQueryResult

Properties:
Name Type Description
rows Array.<Object>
meta *

View Source bucket.js, line 43

# WatchIndexesCallback(err, res)

Parameters:
Name Type Description
err Error
res boolean

View Source queryindexmanager.js, line 411