API Documentation

Title

Global

Members

string

# constant AnalyticsScanConsistency

Properties:
Name Type Description
NotBounded string
RequestPlus string

View Source enums.js, line 110

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 120

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 48

string

# constant ConflictResolutionType

Properties:
Name Type Description
Timestamp string
SequenceNumber string

View Source enums.js, line 61

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
NotRecentlyUsed string
NoEviction string

View Source enums.js, line 34

string

# constant HighlightStyle

Properties:
Name Type Description
HTML string
ANSI string

View Source enums.js, line 149

string

# constant IndexType

Properties:
Name Type Description
Gsi string
View string
Unknown string

View Source enums.js, line 138

Object

# constant LookupInMacro

Properties:
Name Type Description
Document Object
Expiry Object
Cas Object
SeqNo Object
LastModified Object
IsDeleted Object
ValueSizeBytes Object
RevId Object

View Source enums.js, line 200

Object

# constant MutateInMacro

Properties:
Name Type Description
Cas Object
SeqNo Object
ValueCrc32c Object

View Source enums.js, line 216

string

# constant QueryProfileMode

Properties:
Name Type Description
Off string
Phases string
Timings string

View Source enums.js, line 71

string

# constant QueryScanConsistency

Properties:
Name Type Description
NotBounded string
RequestPlus string

View Source enums.js, line 82

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 92

string

# constant SearchScanConsistency

Properties:
Name Type Description
NotBounded string

View Source enums.js, line 191

Object

# constant ServiceType

Properties:
Name Type Description
KeyValue Object
Management Object
Views Object
Query Object
Search Object
Analytics Object

View Source enums.js, line 227

string

# constant ViewErrorMode

Properties:
Name Type Description
Continue string
Stop string

View Source enums.js, line 181

string

# constant ViewOrdering

Properties:
Name Type Description
Ascending string
Descending string

View Source enums.js, line 170

string

# constant ViewScanConsistency

Properties:
Name Type Description
RequestPlus string
UpdateAfter string
NotBounded string

View Source enums.js, line 159

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 361

Object

# AnalyticsResult

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

View Source cluster.js, line 355

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

Object

# AppendResult

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

View Source binarycollection.js, line 75

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
maxExpiry number
compressionMode CompressionMode
minimumDurabilityLevel DurabilityLevel

View Source bucketmanager.js, line 64

# BuildDeferredIndexesCallback(err, res)

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

View Source queryindexmanager.js, line 371

Object

# Cas

View Source binding.js, line 3

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 26

# ConnectCallback(err, cluster)

Parameters:
Name Type Description
err Error
cluster Cluster

View Source cluster.js, line 102

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

Object

# CreateBucketSettings

CreateBucketSettings provides information for creating a bucket.

Properties:
Name Type Description
conflictResolutionType ConflictResolutionType

View Source bucketmanager.js, line 81

# CreateCollectionCallback(err, res)

Parameters:
Name Type Description
err Error
res boolean

View Source collectionmanager.js, line 34

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

# CreateQueryIndexCallback(err, res)

Parameters:
Name Type Description
err Error
res boolean

View Source queryindexmanager.js, line 146

# CreateScopeCallback(err, res)

Parameters:
Name Type Description
err Error
res boolean

View Source collectionmanager.js, line 176

# DecrementCallback(err, res)

Parameters:
Name Type Description
err Error
res DecrementResult

View Source binarycollection.js, line 52

Object

# DecrementResult

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

View Source binarycollection.js, line 45

# DiagnosticsCallback(err, res)

Parameters:
Name Type Description
err Error
res DiagnosticsResult

View Source cluster.js, line 150

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 140

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

# DropCollectionCallback(err, res)

Parameters:
Name Type Description
err Error
res boolean

View Source collectionmanager.js, line 116

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

# DropPrimaryIndexCallback(err, res)

Parameters:
Name Type Description
err Error
res boolean

View Source queryindexmanager.js, line 291

# DropQueryIndexCallback(err, res)

Parameters:
Name Type Description
err Error
res boolean

View Source queryindexmanager.js, line 254

# DropScopeCallback(err, res)

Parameters:
Name Type Description
err Error
res boolean

View Source collectionmanager.js, line 238

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

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

# FreezePlanCallback(err, res)

Parameters:
Name Type Description
err Error
res boolean

View Source searchindexmanager.js, line 421

# GetAllAnalyticsIndexesCallback(err, indexes)

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

View Source analyticsindexmanager.js, line 445

# GetAllBucketsCallback(err, res)

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

View Source bucketmanager.js, line 289

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

# GetAllQueryIndexesCallback(err, res)

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

View Source queryindexmanager.js, line 327

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

# GetAndLockCallback(err, res)

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

View Source collection.js, line 870

Object

# GetAndLockResult

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

View Source collection.js, line 863

# GetAndTouchCallback(err, res)

Parameters:
Name Type Description
err Error
res GetAndTouchResult

View Source collection.js, line 729

Object

# GetAndTouchResult

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

View Source collection.js, line 722

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

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

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

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

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

Object

# LoggingEntry

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

View Source connection.js, line 36

# LookupInCallback(err, res)

Parameters:
Name Type Description
err Error
res LookupInResult

View Source collection.js, line 1062

Object

# LookupInResult

Properties:
Name Type Description
content *
cas Cas

View Source collection.js, line 1056

# MutateCallback(err, res)

Parameters:
Name Type Description
err Error
res MutationResult

View Source collection.js, line 596

# MutateInCallback(err, res)

Parameters:
Name Type Description
err Error
res MutateInResult

View Source collection.js, line 1151

Object

# MutateInResult

Properties:
Name Type Description
content *

View Source collection.js, line 1146

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

Object

# MutationToken

View Source binding.js, line 7

# PauseIngestCallback(err, res)

Parameters:
Name Type Description
err Error
res boolean

View Source searchindexmanager.js, line 253

# PingCallback(err, res)

Parameters:
Name Type Description
err Error
res PingResult

View Source cluster.js, line 245

Object

# PingResult

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 235

# PrependCallback(err, res)

Parameters:
Name Type Description
err Error
res PrependResult

View Source binarycollection.js, line 108

Object

# PrependResult

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

View Source binarycollection.js, line 102

# PublishDesignDocumentCallback(err, res)

Parameters:
Name Type Description
err Error
res boolean

View Source viewindexmanager.js, line 239

# QueryCallback(err, res)

Parameters:
Name Type Description
err Error
res QueryResult

View Source cluster.js, line 287

Object

# QueryResult

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

View Source cluster.js, line 281

# RemoveCallback(err, res)

Parameters:
Name Type Description
err Error
res RemoveResult

View Source collection.js, line 664

Object

# RemoveResult

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

View Source collection.js, line 658

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

Object

# SearchQueryResult

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

View Source cluster.js, line 414

# TouchCallback(err, res)

Parameters:
Name Type Description
err Error
res TouchResult

View Source collection.js, line 804

Object

# TouchResult

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

View Source collection.js, line 798

# UnlockCallback(err, res)

Parameters:
Name Type Description
err Error
res UnlockResult

View Source collection.js, line 935

Object

# UnlockResult

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

View Source collection.js, line 928

# UpdateBucketCallback(err, res)

Parameters:
Name Type Description
err Error
res boolean

View Source bucketmanager.js, line 140

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

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

# ViewQueryCallback(err, res)

Parameters:
Name Type Description
err Error
res ViewQueryResult

View Source bucket.js, line 80

Object

# ViewQueryResult

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

View Source bucket.js, line 74

# WatchIndexesCallback(err, res)

Parameters:
Name Type Description
err Error
res boolean

View Source queryindexmanager.js, line 438