package
0.0.0-20250312052118-2008840fee0c
Repository: https://github.com/couchbase/indexing.git
Documentation: pkg.go.dev
# Functions
CleanupHost returns the hostname with the given suffix removed.
Connect to a couchbase cluster.
ConnectWithAuth connects to a couchbase cluster with the given authentication handler.
FindCommonSuffix returns the longest common suffix from the given strings.
GetBucket is a convenience function for getting a named bucket from a URL.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Get seqnos of vbuckets in active/replica/pending state.
No description provided by the author
No description provided by the author
No description provided by the author
Make hostnames comparable for terse-buckets info and old buckets info.
ParseURL is a wrapper around url.Parse with some sanity-checking.
# Constants
AddOnly indicates an item should only be written if it doesn't exist, otherwise ErrKeyExists is returned.
Append indicates the given value should be appended to the existing value for the given key.
16.
No description provided by the author
20 Mb.
Indexable causes the operation to block until it's availble via the index.
No description provided by the author
No description provided by the author
Redifining the constants to avoid cyclic dependency.
Persist causes the operation to block until the server confirms the item is persisted.
Raw specifies that the value is raw []byte or nil; don't JSON-encode it.
No description provided by the author
Return this as the error from an UpdateFunc to cancel the Update operation.
# Variables
ClientOpCallback is called for each invocation of Do.
ConnPoolAvailWaitTime is the amount of time to wait for an existing connection from the pool before considering the creation of a new one.
ConnPoolTimeout is notified whenever connections are acquired from a pool.
Default timeout for retrieving a connection from the pool.
Error returned from Write with AddOnly flag, when key already exists in the bucket.
No description provided by the author
ErrorClosed.
ErrorFailoverLog.
ErrorInconsistentDcpStats.
ErrorInvalidBucket.
ErrorInvalidVbucket.
ErrorTimeoutDcpStats.
Returned from WaitForPersistence (or Write, if the Persistent or Indexable flag is used) if the value has been overwritten by another before being persisted.
Returned from WaitForPersistence (or Write, if the Persistent or Indexable flag is used) if the value hasn't been persisted by the timeout interval.
No description provided by the author
Timeout value for HTTP requests.
No description provided by the author
Maximum number of times to retry a chunk of a bulk get on error.
HTTPClient to use for REST and view operations.
PoolOverflow is the number of overflow connections allowed in a pool.
PoolSize is the size of each connection pool (per host).
If this is set to a nonzero duration, Do() and ViewCustom() will log a warning if the call takes longer than that.
# Structs
Bucket is the primary entry point for most data operations.
Get SASL buckets.
No description provided by the author
A Client is the starting point for all services across all buckets in a Couchbase cluster.
DcpFeed streams mutation events from a bucket.
FeedInfo is dcp-feed from a single connection.
A Node is a computer in a cluster running the couchbase software.
NodeServices is all the bucket-independent services running on a node (given by Hostname).
A Pool of nodes and buckets.
Pools represents the collection of pools as returned from the REST API.
PoolServices is all the bucket-independent services in a pool.
RestPool represents a single pool returned from the pools REST API.
No description provided by the author
No description provided by the author
No description provided by the author
A TapFeed streams mutation events from a bucket.
VBucketServerMap is the a mapping of vbuckets to nodes.
# Interfaces
AuthHandler is a callback that gets the auth username and password for the given bucket.
GenericMcdAuthHandler is a kind of AuthHandler that performs special auth exchange (like non-standard auth, possibly followed by select-bucket).
No description provided by the author
# Type aliases
Deprecated: Make a valid DCP feed name.
FailoverLog for list of vbuckets.
An UpdateFunc is a callback function to update a document.
No description provided by the author
WriteOptions is the set of option flags availble for the Write method.
A WriteUpdateFunc is a callback function to update a document.