Members
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> |
Type Definitions
# AllowQueryingCallback()
# AnalyticsDataset
Properties:
Name | Type | Description |
---|---|---|
name |
string | |
dataverseName |
string | |
linkName |
string | |
bucketName |
string |
# AnalyticsIndex
Properties:
Name | Type | Description |
---|---|---|
name |
string | |
datasetName |
string | |
dataverseName |
string | |
isPrimary |
boolean |
# AnalyticsQueryCallback()
# AnalyzeDocumentCallback()
# AppendCallback()
# AppendResult
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
cas |
Cas | ||
mutationToken |
MutationToken |
<optional> |
# 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 |
# BuildDeferredIndexesCallback()
# ConnectCallback()
# ConnectLinkCallback()
# CreateAnalyticsIndexCallback()
# CreateBucketCallback()
# CreateBucketSettings
CreateBucketSettings provides information for creating a bucket.
Properties:
Name | Type | Description |
---|---|---|
conflictResolutionType |
ConflictResolutionType |
# CreateCollectionCallback()
# CreateDatasetCallback()
# CreateDataverseCallback()
# CreatePrimaryIndexCallback()
# CreateQueryIndexCallback()
# CreateScopeCallback()
# DecrementCallback()
# DecrementResult
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
value |
integer | ||
cas |
Cas | ||
mutationToken |
MutationToken |
<optional> |
# DiagnosticsCallback()
# DiagnosticsResult
Contains the results from a previously executed Diagnostics operation.
Properties:
Name | Type | Description |
---|---|---|
id |
string | |
version |
number | |
sdk |
string | |
services |
* |
# DisallowQueryingCallback()
# DisconnectLinkCallback()
# DropAnalyticsIndexCallback()
# DropBucketCallback()
# DropCollectionCallback()
# DropDatasetCallback()
# DropDataverseCallback()
# DropDesignDocumentCallback()
# DropGroupCallback()
# DropPrimaryIndexCallback()
# DropQueryIndexCallback()
# DropScopeCallback()
# DropSearchIndexCallback()
# DropUserCallback()
# ExistsCallback()
# ExistsResult
Contains the results from a previously execute Get operation.
Properties:
Name | Type | Description |
---|---|---|
exists |
boolean | |
cas |
Cas |
# FlushBucketCallback()
# FreezePlanCallback()
# GetAllBucketsCallback()
# GetAllDatasetsCallback()
# GetAllDesignDocumentsCallback()
# GetAllGroupsCallback()
# GetAllIndexesCallback()
# GetAllIndexesCallback()
# GetAllReplicasCallback()
# GetAllSearchIndexesCallback()
# GetAllUsersCallback()
# GetAndLockCallback()
# GetAndLockResult
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
content |
* | ||
cas |
Cas | ||
mutationToken |
MutationToken |
<optional> |
# GetAndTouchCallback()
# GetAndTouchResult
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
content |
* | ||
cas |
Cas | ||
mutationToken |
MutationToken |
<optional> |
# GetAnyReplicaCallback()
# GetBucketCallback()
# GetCallback()
# GetDesignDocumentCallback()
# GetGroupCallback()
# GetIndexedDocumentsCountCallback()
# GetPendingMutationsCallback()
# GetReplicaResult
Contains the results from a previously executed replica get operation.
Properties:
Name | Type | Description |
---|---|---|
value |
* | |
cas |
Cas | |
isReplica |
boolean |
# GetResult
Contains the results from a previously execute Get operation.
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
content |
* | ||
cas |
Cas | ||
expiry |
integer |
<optional> |
# GetRolesCallback()
# GetSearchIndexCallback()
# GetUserCallback()
# IncrementCallback()
# IncrementResult
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
value |
integer | ||
cas |
Cas | ||
mutationToken |
MutationToken |
<optional> |
# LoggingCallback()
# LoggingEntry
Properties:
Name | Type | Description |
---|---|---|
severity |
number | |
srcFile |
string | |
srcLine |
number | |
subsys |
string | |
message |
string |
# LookupInCallback()
# MutateInCallback()
# MutationCallback()
# MutationResult
Contains the results from a previously executed mutation operation.
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
cas |
Cas | ||
mutationToken |
MutationToken |
<optional> |
# PauseIngestCallback()
# PrependCallback()
# PrependResult
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
cas |
Cas | ||
mutationToken |
MutationToken |
<optional> |
# PublishDesignDocumentCallback()
# QueryCallback()
# QueryIndex
Properties:
Name | Type | Description |
---|---|---|
name |
string | |
isPrimary |
boolean | |
type |
string | |
state |
string | |
keyspace |
string | |
indexKey |
string |
# RemoveCallback()
# RemoveResult
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
cas |
Cas | ||
mutationToken |
MutationToken |
<optional> |
# ResumeIngestCallback()
# 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> |
# SearchQueryCallback()
# TouchCallback()
# TouchResult
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
cas |
Cas | ||
mutationToken |
MutationToken |
<optional> |
# UnlockCallback()
# UnlockResult
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
content |
* | ||
cas |
Cas | ||
mutationToken |
MutationToken |
<optional> |