# README
Couchbase Go Core
This package provides the underlying Couchbase IO for the gocb project. If you are looking for the Couchbase Go SDK, you are probably looking for gocb.
Branching Strategy
The gocbcore library maintains a branch for each previous major revision of its API. These branches are introduced just prior to any API breaking changes. Active work is performed on the master branch, with releases being performed as tags. Work made on master which are not yet part of a tagged released should be considered liable to change.
License
Copyright 2017 Couchbase Inc.
Licensed under the Apache License, Version 2.0.
See LICENSE for further details.
# Functions
AcquireTimer acquires a time from a global pool of timers maintained by the library.
ControlledBackoff calculates a backoff time duration from the retry attempts on a given request.
CreateAgent creates an agent for performing normal operations.
CreateDcpAgent creates an agent for performing DCP operations.
DecodeCommonFlags decodes a flags value into a data type and compression type using the common flags specification.
DefaultStdioLogger gets the default standard I/O logger.
EncodeCommonFlags encodes a data type and compression type into a flags value using the common flags specification.
ExponentialBackoff calculates a backoff time duration from the retry attempts on a given request.
NewBestEffortRetryStrategy returns a new BestEffortRetryStrategy which will use the supplied calculator function to calculate retry durations.
NewStreamFilter returns a new StreamFilter.
ReleaseTimer returns a timer to the global pool of timers maintained by the library.
SaslAuthPlain performs PLAIN SASL authentication against an AuthClient.
SaslAuthScramSha1 performs SCRAM-SHA1 SASL authentication against an AuthClient.
SaslAuthScramSha256 performs SCRAM-SHA256 SASL authentication against an AuthClient.
SaslAuthScramSha512 performs SCRAM-SHA512 SASL authentication against an AuthClient.
SetLogger sets a logger to be used by the library.
SetLogRedactionLevel specifies the level with which logs should be redacted.
VerboseStdioLogger is a more verbose level of DefaultStdioLogger().
Version returns a string representation of the current SDK version.
# Constants
BinaryType indicates the value is binary data.
CapiService represents a CouchAPI service (typically for views).
CbasService represents an analytics service.
ClusterCapabilityEnhancedPreparedStatements represents that the cluster supports enhanced prepared statements.
DatatypeFlagCompressed indicates the value payload is compressed.
DatatypeFlagJSON indicates the server believes the value payload to be JSON.
DatatypeFlagXattrs indicates the inclusion of xattr data in the value payload.
DcpAgentPriorityHigh sets the priority for the dcp stream to high.
DcpAgentPriorityLow sets the priority for the dcp stream to low.
DcpAgentPriorityMed sets the priority for the dcp stream to medium.
DcpOpenFlagIncludeXattrs indicates the client wishes to receive extended attributes.
DcpOpenFlagNotifier indicates this connection wants the other end to be a notifier.
DcpOpenFlagNoValue indicates the client does not wish to receive mutation values.
DcpOpenFlagProducer indicates this connection wants the other end to be a producer.
DcpStreamAddFlagActiveOnly indicates this stream should only connect to an active vbucket.
DcpStreamAddFlagDiskOnly indicates that stream should only send items if they are on disk.
DcpStreamAddFlagLatest indicates this stream wants to get data up to the latest seqno.
DcpStreamAddFlagStrictVBUUID indicates the vbuuid must match unless the start seqno is 0 and the vbuuid is also 0.
FeatureAltRequests indicates support for requests with flexible frame extras.
FeatureClusterMapNotif indicates support for cluster-map update notifications.
FeatureCollections indicates support for collections.
FeatureDatatype indicates support for Datatype fields.
FeatureDuplex indicates support for duplex communications.
FeatureDurations indicates support for server durations.
FeatureEnhancedDurability indicates support for requests synchronous durability requirements.
FeatureJSON indicates support for JSON datatype data.
FeatureSelectBucket indicates support for the SelectBucket operation.
FeatureSeqNo indicates support for mutation tokens.
FeatureSnappy indicates support for snappy compressed documents.
FeatureTCPDelay indicates support for TCP delay.
FeatureTCPNoDelay indicates support for TCP no-delay.
FeatureTLS indicates support for TLS.
FeatureUnorderedExec indicates support for unordered execution of operations.
FeatureXattr indicates support for document xattrs.
FeatureXerror indicates support for extended errors.
ForceMetaOp disables conflict resolution for the document and allows the operation to be applied to an active, pending, or replica vbucket.
FtsService represents a full-text-search service.
IsExpiration indicates that the message is for an expired document.
JSONType indicates the value is JSON data.
KeyStateDeleted indicates that the key has been written to disk as deleted.
KeyStateNotFound indicates that the key is not found in memory or on disk.
KeyStateNotPersisted indicates the key is in memory, but not yet written to disk.
KeyStatePersisted indicates that the key has been written to disk.
Various logging levels (or subsystems) which can categorize the message.
Various logging levels (or subsystems) which can categorize the message.
Various logging levels (or subsystems) which can categorize the message.
Various logging levels (or subsystems) which can categorize the message.
Various logging levels (or subsystems) which can categorize the message.
Various logging levels (or subsystems) which can categorize the message.
Various logging levels (or subsystems) which can categorize the message.
Majority specifies that a change must be replicated to (held in memory) a majority of the nodes for the bucket.
MajorityAndPersistOnMaster specifies that a change must be replicated to (held in memory) a majority of the nodes for the bucket and additionally persisted to disk on the active node.
MemdService represents a memcached service.
MgmtService represents a management service (typically ns_server).
N1qlService represents a N1QL service (typically for query).
NoCompression indicates that no compression is being used.
PersistToMajority specifies that a change must be persisted to (written to disk) a majority for the bucket.
PlainAuthMechanism represents that PLAIN auth should be performed.
RedactFull indicates to fully redact all possible identifying information from logs.
RedactNone indicates to perform no redactions.
RedactPartial indicates to redact all possible user-identifying information from logs.
RegenerateCas causes the server to invalidate the current CAS value for a document, and to generate a new one.
ScramSha1AuthMechanism represents that SCRAM SHA1 auth should be performed.
ScramSha256AuthMechanism represents that SCRAM SHA256 auth should be performed.
ScramSha512AuthMechanism represents that SCRAM SHA512 auth should be performed.
SkipConflictResolution disables conflict resolution for the document.
StatusAccessError occurs when an access error occurs.
StatusAuthContinue occurs in multi-step authentication when more authentication work needs to be performed in order to complete the authentication process.
StatusAuthError occurs when the authentication information provided was not valid.
StatusAuthStale occurs when authentication credentials have become invalidated.
StatusBadDelta occurs when an invalid delta value is specified to a counter operation.
StatusBusy occurs when the server is too busy to process your request right away.
StatusCollectionUnknown occurs when a Collection cannot be found.
StatusDurabilityImpossible occurs when a request is performed with impossible durability level requirements.
StatusDurabilityInvalidLevel occurs when an invalid durability level was requested.
StatusInternalError occurs when internal errors prevent the server from processing your request.
StatusInvalidArgs occurs when the server receives invalid arguments for an operation.
StatusKeyExists occurs when an operation is performed on a key that could not be found.
StatusKeyNotFound occurs when an operation is performed on a key that does not exist.
StatusLocked occurs when an operation fails due to the document being locked.
StatusNoBucket occurs when no bucket was selected on a connection.
StatusNotInitialized is sent by servers which are still initializing, and are not yet ready to accept operations on behalf of a particular bucket.
StatusNotMyVBucket occurs when an operation is dispatched to a server which is non-authoritative for a specific vbucket.
StatusNotStored occurs when the server fails to store a key.
StatusNotSupported occurs when an operation is understood by the server, but that operation is not supported on this server (occurs for a variety of reasons).
StatusOutOfMemory occurs when the server cannot service a request due to memory limitations.
StatusRangeError occurs when the range specified to the server is not valid.
StatusRollback occurs when a DCP stream fails to open due to a rollback having previously occurred since the last time the stream was opened.
StatusScopeUnknown occurs when a Scope cannot be found.
StatusSubDocBadCombo occurs when a multi-operation sub-document operation is performed and operations within the package of ops conflict with each other.
StatusSubDocBadDelta occurs when a sub-document counter operation is performed and the specified delta is not valid.
StatusSubDocBadMulti occurs when a multi-operation sub-document operation is performed and operations within the package of ops conflict with each other.
StatusSubDocBadRange occurs when a sub-document operation is performed with a bad range.
StatusSubDocCantInsert occurs when a sub-document operation could not insert.
StatusSubDocDocTooDeep occurs when an operation would cause a document to be nested beyond the depth limits allowed by the sub-document specification.
StatusSubDocMultiPathFailureDeleted occurs when a Multi Path Failure occurs on a soft-deleted document.
StatusSubDocNotJSON occurs when a sub-document operation is performed on a document which is not JSON.
StatusSubDocPathExists occurs when a sub-document operation expects a path not to exists, but the path was found in the document.
StatusSubDocPathInvalid occurs when a sub-document path could not be parsed.
StatusSubDocPathMismatch occurs when a sub-document operation specifies a path which does not match the document structure (field access on an array).
StatusSubDocPathNotFound occurs when a sub-document operation targets a path which does not exist in the specifie document.
StatusSubDocPathTooBig occurs when a sub-document path is too big.
StatusSubDocSuccessDeleted occurs when a multi-operation sub-document operation is performed on a soft-deleted document.
StatusSubDocValueTooDeep occurs when a sub-document operation specifies a value which is deeper than the depth limits of the sub-document specification.
StatusSubDocXattrCannotModifyVAttr occurs when a mutation is attempted upon a virtual attribute (which are immutable by definition).
StatusSubDocXattrInvalidFlagCombo occurs when an invalid set of extended-attribute flags is passed to a sub-document operation.
StatusSubDocXattrInvalidKeyCombo occurs when an invalid set of key operations are specified for a extended-attribute sub-document operation.
StatusSubDocXattrUnknownMacro occurs when an invalid macro value is specified.
StatusSubDocXattrUnknownVAttr occurs when an invalid virtual attribute is specified.
StatusSuccess indicates the operation completed successfully.
StatusSyncWriteAmbiguous occurs when an SyncWrite does not complete in the specified time and the result is ambiguous.
StatusSyncWriteInProgress occurs when an attempt is made to write to a key that has a SyncWrite pending.
StatusSyncWriteReCommitInProgress occurs when an SyncWrite is being recommitted.
StatusTmpFail occurs when a temporary failure is preventing the server from processing your request.
StatusTooBig occurs when an operation attempts to store more data in a single document than the server is capable of storing (by default, this is a 20MB limit).
StatusUnknownCommand occurs when an unknown operation is sent to a server.
StreamEventCollectionChanged is the StreamEventCode for a collection changed event.
StreamEventCollectionCreate is the StreamEventCode for a collection create event.
StreamEventCollectionDelete is the StreamEventCode for a collection delete event.
StreamEventCollectionFlush is the StreamEventCode for a collection flush event.
StreamEventScopeCreate is the StreamEventCode for a scope create event.
StreamEventScopeDelete is the StreamEventCode for a scope delete event.
StringType indicates the value is string data.
SubdocDocFlagAccessDeleted indicates that you wish to receive soft-deleted documents.
SubdocDocFlagAddDoc indices that this operation should be an add rather than set.
SubdocDocFlagMkDoc indicates that the document should be created if it does not already exist.
SubdocDocFlagNone indicates no special treatment for this operation.
SubdocFlagExpandMacros indicates that the value portion of any sub-document mutations should be expanded if they contain macros such as ${Mutation.CAS}.
SubdocFlagMkDirP indicates that the path should be created if it does not already exist.
SubdocFlagNone indicates no special treatment for this operation.
SubdocFlagXattrPath indicates that the path refers to an Xattr rather than the document body.
SubDocOpAddDoc represents a full document add, for use with extended attribute ops.
SubDocOpArrayAddUnique indicates the operation is a sub-document `ArrayAddUnique` operation.
SubDocOpArrayInsert indicates the operation is a sub-document `ArrayInsert` operation.
SubDocOpArrayPushFirst indicates the operation is a sub-document `ArrayPushFirst` operation.
SubDocOpArrayPushLast indicates the operation is a sub-document `ArrayPushLast` operation.
SubDocOpCounter indicates the operation is a sub-document `Counter` operation.
SubDocOpDelete indicates the operation is a sub-document `Remove` operation.
SubDocOpDeleteDoc represents a full document delete, for use with extended attribute ops.
SubDocOpDictAdd indicates the operation is a sub-document `Add` operation.
SubDocOpDictSet indicates the operation is a sub-document `Set` operation.
SubDocOpExists indicates the operation is a sub-document `Exists` operation.
SubDocOpGet indicates the operation is a sub-document `Get` operation.
SubDocOpGetCount indicates the operation is a sub-document `GetCount` operation.
SubDocOpGetDoc represents a full document retrieval, for use with extended attribute ops.
SubDocOpReplace indicates the operation is a sub-document `Replace` operation.
SubDocOpSetDoc represents a full document set, for use with extended attribute ops.
UnknownCompression indicates that the compression type is unknown.
UnknownType indicates the values type is unknown.
UseLwwConflictResolution switches to Last-Write-Wins conflict resolution for the document.
VbucketStateActive indicates the vbucket is active on this server.
VbucketStateDead indicates the vbucket is no longer valid on this server.
VbucketStatePending indicates the vbucket is preparing to become active on this server.
VbucketStateReplica indicates the vbucket is a replica on this server.
# Variables
AnalyticsTemporaryFailureRetryReason indicates that an analytics operation failed due to a temporary failure.
CircuitBreakerOpenRetryReason indicates that the operation failed because the circuit breaker for the underlying socket was open.
Shared Error Definitions RFC#58@15.
Shared Error Definitions RFC#58@15.
ErrBadHosts occurs when the list of hosts specified cannot be contacted.
ErrBucketAlreadySelected occurs when SelectBucket is called when a bucket is already selected..
Management Error Definitions RFC#58@15.
Management Error Definitions RFC#58@15.
Shared Error Definitions RFC#58@15.
Shared Error Definitions RFC#58@15.
ErrCliInternalError indicates an internal error occurred within the client.
Management Error Definitions RFC#58@15.
Shared Error Definitions RFC#58@15.
ErrCollectionsUnsupported occurs when collections are used but either server does not support them or the agent was created without them enabled.
Analytics Error Definitions RFC#58@15.
Analytics Error Definitions RFC#58@15.
Analytics Error Definitions RFC#58@15.
Analytics Error Definitions RFC#58@15.
Analytics Error Definitions RFC#58@15.
ErrDCPBackfillFailed occurs when there was an issue starting the backfill on the server e.g.
ErrDCPStreamClosed occurs when a DCP stream is closed gracefully.
ErrDCPStreamDisconnected occurs when a DCP stream is disconnected.
ErrDCPStreamFilterEmpty occurs when all of the collections for a DCP stream are dropped.
ErrDCPStreamStateChanged occurs when a DCP stream is interrupted by failover.
ErrDCPStreamTooSlow occurs when a DCP stream is cancelled due to the application not keeping up with the rate of flow of DCP events sent by the server.
Shared Error Definitions RFC#58@15.
Key Value Error Definitions RFC#58@15.
View Error Definitions RFC#58@15.
Key Value Error Definitions RFC#58@15.
Key Value Error Definitions RFC#58@15.
Key Value Error Definitions RFC#58@15.
Key Value Error Definitions RFC#58@15.
Key Value Error Definitions RFC#58@15.
Key Value Error Definitions RFC#58@15.
Key Value Error Definitions RFC#58@15.
Key Value Error Definitions RFC#58@15.
Key Value Error Definitions RFC#58@15.
Key Value Error Definitions RFC#58@15.
Shared Error Definitions RFC#58@15.
ErrFeatureNotAvailable occurs when an operation is performed on a bucket which does not support it.
Management Error Definitions RFC#58@15.
Shared Error Definitions RFC#58@15.
Query Error Definitions RFC#58@15.
Shared Error Definitions RFC#58@15.
Shared Error Definitions RFC#58@15.
Shared Error Definitions RFC#58@15.
ErrInvalidCertificate occurs when a certificate that is not useable is passed to an Agent.
ErrInvalidCredentials is returned when an invalid set of credentials is provided for a service.
ErrInvalidReplica occurs when an explicit, but invalid replica index is specified.
ErrInvalidServer occurs when an explicit, but invalid server index is specified.
ErrInvalidService occurs when an explicit but invalid service type is specified.
ErrInvalidVBucket occurs when an explicit, but invalid vbucket index is specified.
Analytics Error Definitions RFC#58@15.
Analytics Error Definitions RFC#58@15.
ErrMemdAccessError occurs when an access error occurs.
ErrMemdAuthContinue occurs in multi-step authentication when more authentication work needs to be performed in order to complete the authentication process.
ErrMemdAuthError occurs when the authentication information provided was not valid.
ErrMemdAuthStale occurs when authentication credentials have become invalidated.
ErrMemdBadDelta occurs when an invalid delta value is specified to a counter operation.
ErrMemdBusy occurs when the server is too busy to process your request right away.
ErrMemdCollectionNotFound occurs when a Collection cannot be found.
ErrMemdDurabilityImpossible occurs when a request is performed with impossible durability level requirements.
ErrMemdDurabilityInvalidLevel occurs when an invalid durability level was requested.
ErrMemdInternalError occurs when internal errors prevent the server from processing your request.
ErrMemdInvalidArgs occurs when the server receives invalid arguments for an operation.
ErrMemdKeyExists occurs when an operation is performed on a key that could not be found.
ErrMemdKeyNotFound occurs when an operation is performed on a key that does not exist.
ErrMemdLocked occurs when a document is already locked.
ErrMemdNoBucket occurs when no bucket was selected on a connection.
ErrMemdNotInitialized is sent by servers which are still initializing, and are not yet ready to accept operations on behalf of a particular bucket.
ErrMemdNotMyVBucket occurs when an operation is dispatched to a server which is non-authoritative for a specific vbucket.
ErrMemdNotStored occurs when the server fails to store a key.
ErrMemdNotSupported occurs when an operation is understood by the server, but that operation is not supported on this server (occurs for a variety of reasons).
ErrMemdOutOfMemory occurs when the server cannot service a request due to memory limitations.
ErrMemdRangeError occurs when the range specified to the server is not valid.
ErrMemdRollback occurs when a DCP stream fails to open due to a rollback having previously occurred since the last time the stream was opened.
ErrMemdScopeNotFound occurs when a Collection cannot be found.
ErrMemdSubDocBadCombo occurs when a multi-operation sub-document operation is performed and operations within the package of ops conflict with each other.
ErrMemdSubDocBadDelta occurs when a sub-document counter operation is performed and the specified delta is not valid.
ErrMemdSubDocBadMulti occurs when a multi-operation sub-document operation is performed and operations within the package of ops conflict with each other.
ErrMemdSubDocBadRange occurs when a sub-document operation is performed with a bad range.
ErrMemdSubDocCantInsert occurs when a sub-document operation could not insert.
ErrMemdSubDocDocTooDeep occurs when an operation would cause a document to be nested beyond the depth limits allowed by the sub-document specification.
ErrMemdSubDocMultiPathFailureDeleted occurs when a Multi Path Failure occurs on a soft-deleted document.
ErrMemdSubDocNotJSON occurs when a sub-document operation is performed on a document which is not JSON.
ErrMemdSubDocPathExists occurs when a sub-document operation expects a path not to exists, but the path was found in the document.
ErrMemdSubDocPathInvalid occurs when a sub-document path could not be parsed.
ErrMemdSubDocPathMismatch occurs when a sub-document operation specifies a path which does not match the document structure (field access on an array).
ErrMemdSubDocPathNotFound occurs when a sub-document operation targets a path which does not exist in the specifie document.
ErrMemdSubDocPathTooBig occurs when a sub-document path is too big.
ErrMemdSubDocSuccessDeleted occurs when a multi-operation sub-document operation is performed on a soft-deleted document.
ErrMemdSubDocValueTooDeep occurs when a sub-document operation specifies a value which is deeper than the depth limits of the sub-document specification.
ErrMemdSubDocXattrCannotModifyVAttr occurs when a mutation is attempted upon a virtual attribute (which are immutable by definition).
ErrMemdSubDocXattrInvalidFlagCombo occurs when an invalid set of extended-attribute flags is passed to a sub-document operation.
ErrMemdSubDocXattrInvalidKeyCombo occurs when an invalid set of key operations are specified for a extended-attribute sub-document operation.
ErrMemdSubDocXattrUnknownMacro occurs when an invalid macro value is specified.
ErrMemdSubDocXattrUnknownVAttr occurs when an invalid virtual attribute is specified.
ErrMemdSyncWriteAmbiguous occurs when an SyncWrite does not complete in the specified time and the result is ambiguous.
ErrMemdSyncWriteInProgess occurs when an attempt is made to write to a key that has a SyncWrite pending.
ErrMemdSyncWriteReCommitInProgress occurs when an SyncWrite is being recommitted.
ErrMemdTmpFail occurs when a temporary failure is preventing the server from processing your request.
ErrMemdTooBig occurs when an operation attempts to store more data in a single document than the server is capable of storing (by default, this is a 20MB limit).
ErrMemdUnknownCommand occurs when an unknown operation is sent to a server.
Key Value Error Definitions RFC#58@15.
ErrNoReplicas occurs when no replicas respond in time.
ErrNoSupportedMechanisms occurs when the server does not support any of the authentication methods that the client finds suitable.
Key Value Error Definitions RFC#58@15.
ErrOverload occurs when too many operations are dispatched and all queues are full.
Shared Error Definitions RFC#58@15.
Key Value Error Definitions RFC#58@15.
Key Value Error Definitions RFC#58@15.
Key Value Error Definitions RFC#58@15.
Key Value Error Definitions RFC#58@15.
Key Value Error Definitions RFC#58@15.
Key Value Error Definitions RFC#58@15.
Query Error Definitions RFC#58@15.
Query Error Definitions RFC#58@15.
ErrProtocol occurs when the server responds with unexpected or unparseable data.
Shared Error Definitions RFC#58@15.
Management Error Definitions RFC#58@15.
Shared Error Definitions RFC#58@15.
Shared Error Definitions RFC#58@15.
ErrShutdown occurs when operations are performed on a previously closed Agent.
ErrSocketClosed occurs when a socket closes while an operation is in flight.
Shared Error Definitions RFC#58@15.
ErrTimeout occurs when an operation does not receive a response in a timely manner.
Shared Error Definitions RFC#58@15.
Shared Error Definitions RFC#58@15.
Management Error Definitions RFC#58@15.
Management Error Definitions RFC#58@15.
Key Value Error Definitions RFC#58@15.
Key Value Error Definitions RFC#58@15.
Key Value Error Definitions RFC#58@15.
Key Value Error Definitions RFC#58@15.
View Error Definitions RFC#58@15.
Key Value Error Definitions RFC#58@15.
Key Value Error Definitions RFC#58@15.
Key Value Error Definitions RFC#58@15.
Key Value Error Definitions RFC#58@15.
Key Value Error Definitions RFC#58@15.
Key Value Error Definitions RFC#58@15.
KVCollectionOutdatedRetryReason indicates that the operation failed because the collection ID on the request is outdated.
KVErrMapRetryReason indicates that the operation failed for an unsupported reason but the KV error map indicated that the operation can be retried.
KVLockedRetryReason indicates that the operation failed because the document was locked.
KVNotMyVBucketRetryReason indicates that the operation failed because it was sent to the wrong node for the vbucket.
KVSyncWriteInProgressRetryReason indicates that the operation failed because a sync write is in progress.
KVSyncWriteRecommitInProgressRetryReason indicates that the operation failed because a sync write recommit is in progress.
KVTemporaryFailureRetryReason indicates that the operation failed because of a temporary failure.
NodeNotAvailableRetryReason indicates that the operation failed because the requested node was not available.
PipelineOverloadedRetryReason indicates that the operation failed because the pipeline queue was full.
QueryIndexNotFoundRetryReason indicates that the operation failed to to a missing query index.
QueryPreparedStatementFailureRetryReason indicates that the operation failed due to a prepared statement failure.
SearchTooManyRequestsRetryReason indicates that a search operation failed due to too many requests.
ServiceNotAvailableRetryReason indicates that the operation failed because the requested service was not available.
ServiceResponseCodeIndicatedRetryReason indicates that the operation failed and the service responded stating that the request should be retried.
SocketCloseInFlightRetryReason indicates that the operation failed because the socket was closed whilst the operation was in flight.
SocketNotAvailableRetryReason indicates that the operation failed because the underlying socket was not available.
UnknownRetryReason indicates that the operation failed for an unknown reason.
# Structs
AddOptions encapsulates the parameters for a AddEx operation.
AdjoinOptions encapsulates the parameters for a AppendEx or PrependEx operation.
AdjoinResult encapsulates the result of a AppendEx or PrependEx operation.
Agent represents the base client handling connections to a Couchbase Server.
AgentConfig specifies the configuration options for creation of an Agent.
AnalyticsError represents an error returned from an analytics query.
AnalyticsErrorDesc represents specific analytics error data.
AnalyticsQueryOptions represents the various options available for an analytics query.
AnalyticsRowReader providers access to the rows of a analytics query.
AuthCertRequest represents a certificate details request from the agent.
AuthCredsRequest represents an authentication details request from the agent.
BestEffortRetryStrategy represents a strategy that will keep retrying until it succeeds (or the caller times out the request).
BytesAndError contains the raw bytes of the result of an operation, and/or the error that occurred.
CircuitBreakerConfig is the set of configuration settings for configuring circuit breakers.
CounterInResult encapsulates the result of a CounterInEx operation.
CounterOptions encapsulates the parameters for a IncrementEx or DecrementEx operation.
CounterResult encapsulates the result of a IncrementEx or DecrementEx operation.
DeleteInOptions encapsulates the parameters for a DeleteInEx operation.
DeleteInResult encapsulates the result of a DeleteInEx operation.
DeleteMetaOptions encapsulates the parameters for a DeleteMetaEx operation.
DeleteMetaResult encapsulates the result of a DeleteMetaEx operation.
DeleteOptions encapsulates the parameters for a DeleteEx operation.
DeleteResult encapsulates the result of a DeleteEx operation.
DiagnosticInfo is returned by the Diagnostics method and includes information about the overall health of the clients connections.
ExecHelloResponse contains the features and/or error from an ExecHello operation.
ExistsInOptions encapsulates the parameters for a ExistsInEx operation.
ExistsInResult encapsulates the result of a ExistsInEx operation.
FailoverEntry represents a single entry in the server fail-over log.
GetAndLockOptions encapsulates the parameters for a GetAndLockEx operation.
GetAndLockResult encapsulates the result of a GetAndLockEx operation.
GetAndTouchOptions encapsulates the parameters for a GetAndTouchEx operation.
GetAndTouchResult encapsulates the result of a GetAndTouchEx operation.
GetAnyReplicaOptions encapsulates the parameters for a GetAnyReplicaEx operation.
GetCollectionIDOptions are the options available to the GetCollectionID command.
GetCollectionManifestOptions are the options available to the GetCollectionManifest command.
GetInOptions encapsulates the parameters for a GetInEx operation.
GetInResult encapsulates the result of a GetInEx operation.
GetMetaOptions encapsulates the parameters for a GetMetaEx operation.
GetMetaResult encapsulates the result of a GetMetaEx operation.
GetOneReplicaOptions encapsulates the parameters for a GetOneReplicaEx operation.
GetOptions encapsulates the parameters for a GetEx operation.
GetRandomOptions encapsulates the parameters for a GetRandomEx operation.
GetRandomResult encapsulates the result of a GetRandomEx operation.
GetReplicaResult encapsulates the result of a GetReplica operation.
GetResult encapsulates the result of a GetEx operation.
HTTPError represents an error returned from an HTTP request.
HTTPRequest contains the description of an HTTP request to perform.
HTTPResponse encapsulates the response from an HTTP request.
KeyValueError wraps key-value errors that occur within the SDK.
LookupInOptions encapsulates the parameters for a LookupInEx operation.
LookupInResult encapsulates the result of a LookupInEx operation.
Manifest is the representation of a collections manifest.
ManifestCollection is the representation of a collection within a manifest.
ManifestScope is the representation of a scope within a manifest.
MemdConnInfo represents information we know about a particular memcached connection reported in a diagnostics report.
MutateInOptions encapsulates the parameters for a MutateInEx operation.
MutateInResult encapsulates the result of a MutateInEx operation.
MutationToken represents a particular mutation within the cluster.
N1QLError represents an error returned from a n1ql query.
N1QLErrorDesc represents specific n1ql error data.
N1QLQueryOptions represents the various options available for a n1ql query.
N1QLRowReader providers access to the rows of a n1ql query.
NoRetryRetryAction represents an action that indicates to not retry.
ObserveOptions encapsulates the parameters for a ObserveEx operation.
ObserveResult encapsulates the result of a ObserveEx operation.
ObserveVbOptions encapsulates the parameters for a ObserveVbEx operation.
ObserveVbResult encapsulates the result of a ObserveVbEx operation.
PasswordAuthProvider provides a standard AuthProvider implementation for use with a standard username/password pair (for example, RBAC).
PingKvOptions encapsulates the parameters for a PingKvEx operation.
PingKvResult encapsulates the result of a PingKvEx operation.
PingResult contains the results of a ping to a single server.
ReplaceOptions encapsulates the parameters for a ReplaceEx operation.
SaslListMechsCompleted is used to contain the result and/or error from a SaslListMechs operation.
SearchError represents an error returned from a search query.
SearchQueryOptions represents the various options available for a search query.
SearchRowReader providers access to the rows of a view query.
SetMetaOptions encapsulates the parameters for a SetMetaEx operation.
SetMetaResult encapsulates the result of a SetMetaEx operation.
SetOptions encapsulates the parameters for a SetEx operation.
SingleServerStats represents the stats returned from a single server.
StatsOptions encapsulates the parameters for a StatsEx operation.
StatsResult encapsulates the result of a StatsEx operation.
StoreInOptions encapsulates the parameters for a SetInEx, AddInEx, ReplaceInEx, PushFrontInEx, PushBackInEx, ArrayInsertInEx or AddUniqueInEx operation.
StoreInResult encapsulates the result of a SetInEx, AddInEx, ReplaceInEx, PushFrontInEx, PushBackInEx, ArrayInsertInEx or AddUniqueInEx operation.
StoreResult encapsulates the result of a AddEx, SetEx or ReplaceEx operation.
StreamFilter provides options for filtering a DCP stream.
SubDocOp defines a per-operation structure to be passed to MutateIn or LookupIn for performing many sub-document operations.
SubDocResult encapsulates the results from a single sub-document operation.
SubDocumentError provides additional contextual information to sub-document specific errors.
TouchOptions encapsulates the parameters for a TouchEx operation.
TouchResult encapsulates the result of a TouchEx operation.
UnlockOptions encapsulates the parameters for a UnlockEx operation.
UnlockResult encapsulates the result of a UnlockEx operation.
UserPassPair represents a username and password pair.
VbSeqNoEntry represents a single GetVbucketSeqnos sequence number entry.
VBucketIDStatsTarget indicates that a specific vbucket should be targeted by the StatsEx operation.
ViewError represents an error returned from a view query.
ViewQueryErrorDesc represents specific view error data.
ViewQueryOptions represents the various options available for a view query.
ViewQueryRowReader providers access to the rows of a view query.
WithDurationRetryAction represents an action that indicates to retry with a given duration.
# Interfaces
AuthClient exposes an interface for performing authentication on a connected Couchbase K/V client.
AuthProvider is an interface to allow the agent to fetch authentication credentials on-demand from the application.
Logger defines a logging interface.
PendingOp represents an outstanding operation within the client.
RequestSpan is the interface for spans that are created by a RequestTracer.
RequestSpanContext is the interface for for external span contexts that can be passed in into the SDK option blocks.
RequestTracer describes the tracing abstraction in the SDK.
RetryAction is used by a RetryStrategy to calculate the duration to wait before retrying an operation.
RetryReason represents the reason for an operation possibly being retried.
RetryRequest is a request that can possibly be retried.
RetryStrategy is to determine if an operation should be retried, and if so how long to wait before retrying.
StatsTarget is used for providing a specific target to the StatsEx operation.
StreamObserver provides an interface to receive events from a running DCP stream.
# Type aliases
AdjoinExCallback is invoked upon completion of a AppendEx or PrependEx operation.
AuthFunc is invoked by the agent to authenticate a client.
AuthMechanism represents a type of auth that can be performed.
BackoffCalculator is used by retry strategies to calculate backoff durations.
Cas represents a unique revision of a document.
CircuitBreakerCallback is the callback used by the circuit breaker to determine if an error should count toward the circuit breaker failure count.
CloseStreamCallback is invoked with the results of `CloseStream` operations.
ClusterCapability represents a capability that the cluster supports.
CollectionIDCallback is invoked upon completion of a GetCollectionID operation.
CompressionType indicates the type of compression for a value.
CounterExCallback is invoked upon completion of a IncrementEx or DecrementEx operation.
CounterInExCallback is invoked upon completion of a CounterInEx operation.
CounterInOptions encapsulates the parameters for a CounterInEx operation.
DataType represents the type of data for a value.
DatatypeFlag specifies data flags for the value of a document.
DcpAgentPriority specifies the priority level for a dcp stream.
DcpOpenFlag specifies flags for DCP connections configured when the stream is opened.
DcpStreamAddFlag specifies flags for DCP streams configured when the stream is opened.
DeleteExCallback is invoked upon completion of a DeleteEx operation.
DeleteInExCallback is invoked upon completion of a DeleteInEx operation.
DeleteMetaExCallback is invoked upon completion of a DeleteMetaEx operation.
DurabilityLevel specifies the level to use for enhanced durability requirements.
ExistsInExCallback is invoked upon completion of a ExistsInEx operation.
GetAndLockExCallback is invoked upon completion of a GetAndLockEx operation.
GetAndTouchExCallback is invoked upon completion of a GetAndTouchEx operation.
GetExCallback is invoked upon completion of a GetEx operation.
GetFailoverLogCallback is invoked with the results of `GetFailoverLog` operations.
GetInExCallback is invoked upon completion of a GetInEx operation.
GetMetaExCallback is invoked upon completion of a GetMetaEx operation.
GetRandomExCallback is invoked upon completion of a GetRandomEx operation.
GetReplicaExCallback is invoked upon completion of a GetReplica operation.
GetVBucketSeqnosCallback is invoked with the results of `GetVBucketSeqnos` operations.
HelloFeature represents a feature code included in a memcached HELLO operation.
KeyState represents the various storage states of a key on the server.
LogLevel specifies the severity of a log message.
LogRedactLevel specifies the degree with which to redact the logs.
LookupInExCallback is invoked upon completion of a LookupInEx operation.
ManifestCallback is invoked upon completion of a GetCollectionManifest operation.
MutateInExCallback is invoked upon completion of a MutateInEx operation.
ObserveExCallback is invoked upon completion of a ObserveEx operation.
ObserveVbExCallback is invoked upon completion of a ObserveVbEx operation.
OpenStreamCallback is invoked with the results of `OpenStream` operations.
PingKvExCallback is invoked upon completion of a PingKvEx operation.
SeqNo is a sequential mutation number indicating the order and precise position of a write that has occurred.
ServiceType specifies a particular Couchbase service type.
SetMetaExCallback is invoked upon completion of a SetMetaEx operation.
SetMetaOption represents possible option values for a SetMeta operation.
SnapshotState represents the state of a particular cluster snapshot.
StatsExCallback is invoked upon completion of a StatsEx operation.
StatusCode represents a memcached response status.
StoreExCallback is invoked upon completion of a AddEx, SetEx or ReplaceEx operation.
StoreInExCallback is invoked upon completion of a SetInEx, AddInEx, ReplaceInEx, PushFrontInEx, PushBackInEx, ArrayInsertInEx or AddUniqueInEx operation.
StreamEndStatus represents the reason for a DCP stream ending.
StreamEventCode is the code for a DCP Stream event.
SubdocDocFlag specifies document-level flags for a sub-document operation.
SubdocFlag specifies flags for a sub-document operation.
SubDocOpType specifies the type of a sub-document operation.
TouchExCallback is invoked upon completion of a TouchEx operation.
UnlockExCallback is invoked upon completion of a UnlockEx operation.
VbucketState represents the state of a particular vbucket on a particular server.
VbUUID represents a unique identifier for a particular vbucket history.