API Documentation
Tutorials

Title

Global

Members

# constant AnalyticsScanConsistency

View Source enums.js, line 95

# constant AnalyticsStatus

View Source enums.js, line 104

# constant BucketType

View Source enums.js, line 18

# constant CompressionMode

View Source enums.js, line 39

# constant ConflictResolutionType

View Source enums.js, line 50

# constant DurabilityLevel

View Source enums.js, line 6

# constant EvictionPolicy

View Source enums.js, line 29

# lcbVersion

Expose the LCB version that is in use.

View Source couchbase.js, line 62

# constant QueryProfileMode

View Source enums.js, line 59

# constant QueryScanConsistency

View Source enums.js, line 69

# constant QueryStatus

View Source enums.js, line 78

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 *

The connection string of your cluster
options * <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 55

Promise.<Cluster>

Type Definitions

# AllowQueryingCallback()

View Source searchindexmanager.js, line 314

Object

# AnalyticsDataset

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

View Source analyticsindexmanager.js, line 246

Object

# AnalyticsIndex

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

View Source analyticsindexmanager.js, line 415

# AnalyticsQueryCallback()

View Source cluster.js, line 259

Object

# AnalyticsResult

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

View Source cluster.js, line 254

# AnalyzeDocumentCallback()

View Source searchindexmanager.js, line 431

# AppendCallback()

View Source binarycollection.js, line 68

Object

# AppendResult

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

View Source binarycollection.js, line 63

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()

View Source queryindexmanager.js, line 328

# ConnectCallback()

View Source couchbase.js, line 32

# ConnectLinkCallback()

View Source analyticsindexmanager.js, line 465

# CreateAnalyticsIndexCallback()

View Source analyticsindexmanager.js, line 296

# CreateBucketCallback()

View Source bucketmanager.js, line 49

Object

# CreateBucketSettings

CreateBucketSettings provides information for creating a bucket.

Properties:
Name Type Description
conflictResolutionType ConflictResolutionType

View Source bucketmanager.js, line 41

# CreateCollectionCallback()

View Source collectionmanager.js, line 25

# CreateDatasetCallback()

View Source analyticsindexmanager.js, line 127

# CreateDataverseCallback()

View Source analyticsindexmanager.js, line 25

# CreatePrimaryIndexCallback()

View Source queryindexmanager.js, line 146

# CreateQueryIndexCallback()

View Source queryindexmanager.js, line 108

# CreateScopeCallback()

View Source collectionmanager.js, line 137

# DecrementCallback()

View Source binarycollection.js, line 45

Object

# DecrementResult

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

View Source binarycollection.js, line 39

# DiagnosticsCallback()

View Source cluster.js, line 105

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 96

# DisallowQueryingCallback()

View Source searchindexmanager.js, line 353

# DisconnectLinkCallback()

View Source analyticsindexmanager.js, line 498

# DropAnalyticsIndexCallback()

View Source analyticsindexmanager.js, line 365

# DropBucketCallback()

View Source bucketmanager.js, line 145

# DropCollectionCallback()

View Source collectionmanager.js, line 87

# DropDatasetCallback()

View Source analyticsindexmanager.js, line 190

# DropDataverseCallback()

View Source analyticsindexmanager.js, line 76

# DropDesignDocumentCallback()

View Source viewindexmanager.js, line 179

# DropGroupCallback()

View Source usermanager.js, line 670

# DropPrimaryIndexCallback()

View Source queryindexmanager.js, line 244

# DropQueryIndexCallback()

View Source queryindexmanager.js, line 210

# DropScopeCallback()

View Source collectionmanager.js, line 189

# DropSearchIndexCallback()

View Source searchindexmanager.js, line 158

# DropUserCallback()

View Source usermanager.js, line 431

# ExistsCallback()

View Source collection.js, line 343

Object

# ExistsResult

Contains the results from a previously execute Get operation.

Properties:
Name Type Description
exists boolean
cas Cas

View Source collection.js, line 336

# FlushBucketCallback()

View Source bucketmanager.js, line 276

# FreezePlanCallback()

View Source searchindexmanager.js, line 392

# GetAllBucketsCallback()

View Source bucketmanager.js, line 237

# GetAllDatasetsCallback()

View Source analyticsindexmanager.js, line 253

# GetAllDesignDocumentsCallback()

View Source viewindexmanager.js, line 27

# GetAllGroupsCallback()

View Source usermanager.js, line 574

# GetAllIndexesCallback()

View Source analyticsindexmanager.js, line 422

# GetAllIndexesCallback()

View Source queryindexmanager.js, line 287

# GetAllReplicasCallback()

View Source collection.js, line 466

# GetAllSearchIndexesCallback()

View Source searchindexmanager.js, line 78

# GetAllUsersCallback()

View Source usermanager.js, line 323

# GetAndLockCallback()

View Source collection.js, line 794

Object

# GetAndLockResult

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

View Source collection.js, line 788

# GetAndTouchCallback()

View Source collection.js, line 672

Object

# GetAndTouchResult

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

View Source collection.js, line 666

# GetAnyReplicaCallback()

View Source collection.js, line 443

# GetBucketCallback()

View Source bucketmanager.js, line 191

# GetCallback()

View Source collection.js, line 188

# GetDesignDocumentCallback()

View Source viewindexmanager.js, line 77

# GetGroupCallback()

View Source usermanager.js, line 528

# GetIndexedDocumentsCountCallback()

View Source searchindexmanager.js, line 197

# GetPendingMutationsCallback()

View Source analyticsindexmanager.js, line 531

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 434

Object

# GetResult

Contains the results from a previously execute Get operation.

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

View Source collection.js, line 180

# GetRolesCallback()

View Source usermanager.js, line 482

# GetSearchIndexCallback()

View Source searchindexmanager.js, line 39

# GetUserCallback()

View Source usermanager.js, line 272

# IncrementCallback()

View Source binarycollection.js, line 21

Object

# IncrementResult

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

View Source binarycollection.js, line 15

# LoggingCallback()

View Source connection.js, line 43

Object

# LoggingEntry

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

View Source connection.js, line 35

# LookupInCallback()

View Source collection.js, line 977

Object

# LookupInResult

Properties:
Name Type Description
content *

View Source collection.js, line 973

# MutateInCallback()

View Source collection.js, line 1060

Object

# MutateInResult

Properties:
Name Type Description
content *

View Source collection.js, line 1056

# MutationCallback()

View Source collection.js, line 550

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 541

# PauseIngestCallback()

View Source searchindexmanager.js, line 236

# PrependCallback()

View Source binarycollection.js, line 91

Object

# PrependResult

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

View Source binarycollection.js, line 86

# PublishDesignDocumentCallback()

View Source viewindexmanager.js, line 227

# QueryCallback()

View Source cluster.js, line 192

Object

# QueryIndex

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

View Source queryindexmanager.js, line 277

Object

# QueryResult

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

View Source cluster.js, line 187

# RemoveCallback()

View Source collection.js, line 611

Object

# RemoveResult

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

View Source collection.js, line 606

# ResumeIngestCallback()

View Source searchindexmanager.js, line 275

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 24

# SearchQueryCallback()

View Source cluster.js, line 314

Object

# SearchQueryResult

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

View Source cluster.js, line 309

# TouchCallback()

View Source collection.js, line 732

Object

# TouchResult

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

View Source collection.js, line 727

# UnlockCallback()

View Source collection.js, line 855

Object

# UnlockResult

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

View Source collection.js, line 849

# UpdateBucketCallback()

View Source bucketmanager.js, line 97

# UpsertDesignDocumentCallback()

View Source viewindexmanager.js, line 126

# UpsertGroupCallback()

View Source usermanager.js, line 621

# UpsertSearchIndexCallback()

View Source searchindexmanager.js, line 115

# UpsertUserCallback()

View Source usermanager.js, line 376

# ViewQueryCallback()

View Source bucket.js, line 48

Object

# ViewQueryResult

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

View Source bucket.js, line 43

# WatchIndexesCallback()

View Source queryindexmanager.js, line 392