Title

Global

Members

# constant AnalyticsScanConsistency

View Source enums.js, line 93

# constant AnalyticsStatus

View Source enums.js, line 102

# constant BucketType

View Source enums.js, line 16

# constant CompressionMode

View Source enums.js, line 37

# constant ConflictResolutionType

View Source enums.js, line 48

# constant DurabilityLevel

View Source enums.js, line 4

# constant EvictionPolicy

View Source enums.js, line 27

# constant QueryProfileMode

View Source enums.js, line 57

# constant QueryScanConsistency

View Source enums.js, line 67

# constant QueryStatus

View Source enums.js, line 76

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 51

Promise.<Cluster>

Type Definitions

# AllowQueryingCallback()

View Source searchindexmanager.js, line 311

Object

# AnalyticsDataset

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

View Source analyticsindexmanager.js, line 245

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 249

Object

# AnalyticsResult

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

View Source cluster.js, line 244

# AnalyzeDocumentCallback()

View Source searchindexmanager.js, line 428

Object

# AppendResult

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

View Source binarycollection.js, line 61

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 24

# BuildDeferredIndexesCallback()

View Source queryindexmanager.js, line 325

# ConnectCallback()

View Source couchbase.js, line 28

# CreateAnalyticsIndexCallback()

View Source analyticsindexmanager.js, line 295

# CreateBucketCallback()

View Source bucketmanager.js, line 47

Object

# CreateBucketSettings

CreateBucketSettings provides information for creating a bucket.

Properties:
Name Type Description
conflictResolutionType ConflictResolutionType

View Source bucketmanager.js, line 39

# CreateCollectionCallback()

View Source collectionmanager.js, line 23

# CreateDatasetCallback()

View Source analyticsindexmanager.js, line 126

# CreateDataverseCallback()

View Source analyticsindexmanager.js, line 24

# CreatePrimaryIndexCallback()

View Source queryindexmanager.js, line 145

# CreateQueryIndexCallback()

View Source queryindexmanager.js, line 107

# CreateScopeCallback()

View Source collectionmanager.js, line 135

# DecrementCallback()

View Source binarycollection.js, line 43

Object

# DecrementResult

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

View Source binarycollection.js, line 37

# DiagnosticsCallback()

View Source cluster.js, line 95

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 86

# DisallowQueryingCallback()

View Source searchindexmanager.js, line 350

# DisconnectLinkCallback()

View Source analyticsindexmanager.js, line 498

# DropAnalyticsIndexCallback()

View Source analyticsindexmanager.js, line 365

# DropBucketCallback()

View Source bucketmanager.js, line 143

# DropCollectionCallback()

View Source collectionmanager.js, line 84

# DropDataverseCallback()

View Source analyticsindexmanager.js, line 75

# DropDesignDocumentCallback()

View Source viewindexmanager.js, line 172

# DropGroupCallback()

View Source usermanager.js, line 646

# DropPrimaryIndexCallback()

View Source queryindexmanager.js, line 241

# DropQueryIndexCallback()

View Source queryindexmanager.js, line 207

# DropSearchIndexCallback()

View Source searchindexmanager.js, line 155

# DropUserCallback()

View Source usermanager.js, line 412

# ExistsCallback()

View Source collection.js, line 314

Object

# ExistsResult

Contains the results from a previously execute Get operation.

Properties:
Name Type Description
exists boolean
cas Cas

View Source collection.js, line 307

# FlushBucketCallback()

View Source bucketmanager.js, line 274

# GetAllBucketsCallback()

View Source bucketmanager.js, line 235

# GetAllDatasetsCallback()

View Source analyticsindexmanager.js, line 252

# GetAllDesignDocumentsCallback()

View Source viewindexmanager.js, line 25

# GetAllGroupsCallback()

View Source usermanager.js, line 554

# GetAllIndexesCallback()

View Source analyticsindexmanager.js, line 422

# GetAllIndexesCallback()

View Source queryindexmanager.js, line 284

# GetAllReplicasCallback()

View Source collection.js, line 428

# GetAllSearchIndexesCallback()

View Source searchindexmanager.js, line 77

# GetAllUsersCallback()

View Source usermanager.js, line 309

# GetAndLockCallback()

View Source collection.js, line 717

Object

# GetAndLockResult

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

View Source collection.js, line 711

# GetAndTouchCallback()

View Source collection.js, line 608

Object

# GetAndTouchResult

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

View Source collection.js, line 602

# GetAnyReplicaCallback()

View Source collection.js, line 407

# GetBucketCallback()

View Source bucketmanager.js, line 189

# GetDesignDocumentCallback()

View Source viewindexmanager.js, line 74

# GetGroupCallback()

View Source usermanager.js, line 508

# GetIndexedDocumentsCountCallback()

View Source searchindexmanager.js, line 194

# 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 398

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 165

# GetRolesCallback()

View Source usermanager.js, line 463

# GetSearchIndexCallback()

View Source searchindexmanager.js, line 38

# GetUserCallback()

View Source usermanager.js, line 258

# IncrementCallback()

View Source binarycollection.js, line 19

Object

# IncrementResult

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

View Source binarycollection.js, line 13

# LoggingCallback()

View Source connection.js, line 38

Object

# LoggingEntry

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

View Source connection.js, line 30

# LookupInCallback()

View Source collection.js, line 876

Object

# LookupInResult

Properties:
Name Type Description
content *

View Source collection.js, line 872

# MutateInCallback()

View Source collection.js, line 942

Object

# MutateInResult

Properties:
Name Type Description
content *

View Source collection.js, line 938

# MutationCallback()

View Source collection.js, line 496

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 487

# PauseIngestCallback()

View Source searchindexmanager.js, line 233

Object

# PrependResult

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

View Source binarycollection.js, line 84

# PublishDesignDocumentCallback()

View Source viewindexmanager.js, line 217

# QueryCallback()

View Source cluster.js, line 182

Object

# QueryIndex

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

View Source queryindexmanager.js, line 274

Object

# QueryResult

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

View Source cluster.js, line 177

# RemoveCallback()

View Source collection.js, line 554

Object

# RemoveResult

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

View Source collection.js, line 549

# ResumeIngestCallback()

View Source searchindexmanager.js, line 272

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 23

# SearchQueryCallback()

View Source cluster.js, line 304

Object

# SearchQueryResult

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

View Source cluster.js, line 299

# TouchCallback()

View Source collection.js, line 662

Object

# TouchResult

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

View Source collection.js, line 657

# UnlockCallback()

View Source collection.js, line 772

Object

# UnlockResult

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

View Source collection.js, line 766

# UpdateBucketCallback()

View Source bucketmanager.js, line 95

# UpsertDesignDocumentCallback()

View Source viewindexmanager.js, line 120

# UpsertGroupCallback()

View Source usermanager.js, line 600

# UpsertSearchIndexCallback()

View Source searchindexmanager.js, line 114

# UpsertUserCallback()

View Source usermanager.js, line 361

# ViewQueryCallback()

View Source bucket.js, line 47

Object

# ViewQueryResult

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

View Source bucket.js, line 42

# WatchIndexesCallback()

View Source queryindexmanager.js, line 389