All Classes and Interfaces
Class
Description
Base class for FTS queries that are composite, compounding several other
SearchQuery.Internal helper to map the results from the analytics requests.
Represents a dataset (or collection) in analytics.
Holds the data-types for fields to index.
Represents a dataverse in analytics.
Represents an index in analytics.
Performs management operations on analytics indexes.
Represents a Link to an external datasource that is connected with the Analytics service.
Describes the analytics external link types.
Holds associated metadata returned by the server for the performed analytics request.
Holds the metrics as returned from an analytics response.
Allows customizing various analytics query options.
The result of an analytics query, including rows and associated metadata.
The possible values for scan consistency in an analytics request.
Represents a single warning returned from the analytics engine.
Modifies properties of the append operation.
An intention to perform a SubDocument array add-unique operation.
An intention to perform a SubDocument array append operation.
An intention to perform a SubDocument array insert operation.
An intention to perform a SubDocument array prepend operation.
Performs management operations on analytics indexes.
Allows to perform certain operations on non-JSON documents.
Provides access to a Couchbase bucket in an async fashion.
Performs (async) management operations on Buckets.
The
AsyncCluster is the main entry point when connecting to a Couchbase cluster using the async API.The
AsyncCollection provides basic asynchronous access to all collection APIs.The
AsyncCollectionManager provides APIs to manage collections and scopes within a bucket.Performs management operations on query indexes at the Collection level.
A specialized HTTP client for making requests to Couchbase Server.
Performs management operations on
EventingFunctions.Performs management operations on query indexes.
The scope identifies a group of collections and allows high application
density as a result.
Performs management operations on
EventingFunctions.The
AsyncScopeSearchIndexManager allows to manage scope level search indexes.The
AsyncSearchIndexManager allows to manage search index structures in a couchbase cluster.The possible authentication domains that can be used when managing users with RBAC.
Provides additional insight into why a
BatchHelper operation fails.This helper class provides methods that make performing batch operations easy and comfortable.
Allows to perform certain operations on non-JSON documents.
A FTS query that queries fields explicitly indexed as boolean.
A compound FTS query that allows various combinations of sub-queries.
Provides access to a Couchbase bucket in a blocking fashion.
Performs management operations on Buckets.
Represents all properties of a Couchbase Server Bucket.
Specifies the main type of the bucket.
Allows customizing how deferred indexes are built.
The
Cluster is the main entry point when connecting to a Couchbase cluster.The Environment is the main place in the SDK where configuration and state lives (i.e.
Allows specifying custom options when connecting to the cluster.
Marker interface for additional properties that can be loaded via the cluster environment builder.
The
Collection provides blocking, synchronous access to all collection APIs.The
CollectionManager provides APIs to manage bucket collections and scopes.Performs management operations on query indexes at the Collection level.
The
CollectionSpec describes properties of a collection that can be managed.Extends the
CommonOptions to also include the durability requirements.Options common to all HTTP requests.
Common options that are used by most operations.
Specifies the compression mode used on the bucket.
The type of conflict resolution to configure for the bucket.
A compound FTS query that performs a logical AND between all its sub-queries (conjunction).
Customizes how a analytics link is connected.
A coordinate is a tuple of a latitude and a longitude.
A staged builder that holds a coordinate's latitude value.
A staged builder that holds a coordinate's longitude value.
A specialized HTTP client for making requests to Couchbase Server.
An analytics link to a remote couchbase cluster.
Security options for remote Couchbase links.
Result returned from counter (increment, decrement) operations.
Allows to customize the behavior of the create collection operation.
Allows to customize the behavior of the create collection operation.
Allows customizing how datasets are created.
Allows customizing how an analytics dataverse is created.
Customizes how an index is created.
Allows customizing how the analytics links are created.
Allows customizing how a query primary index is created.
Allows customizing how a query index is created.
Allows to customize the behavior of the create scope operation.
A facet that categorizes rows inside date ranges (or buckets) provided by the user.
A FTS query that matches documents on a range of dates.
Implementation of a
DateRangeSearchFacetResult.Modifies properties of the decrement operation.
The default JSON serializer.
Allows to customize the behavior of the eventing functions deploy operation.
A collection of named
Views.Allows to customize the diagnostics report.
Customizes how a analytics link is disconnected.
A compound FTS query that performs a logical OR between all its sub-queries (disjunction).
A FTS query that matches on Couchbase document IDs.
Allows to customize the behavior of the drop collection operation.
Allows customizing how datasets are dropped.
Allows customizing how an analytics dataverse is dropped.
Allows to customize the behavior of the eventing functions drop operation.
Customizes how an index is dropped.
Allows customizing how the analytics links are dropped.
Allows customizing how primary indexes are dropped.
Allows customizing how query indexes are dropped.
Allows to customize the behavior of the drop scope operation.
Deprecated.
The
EncodedFragment represents a fragment returned from a subdocument lookup.Indicates the annotated field should be encrypted during serialization
and decrypted during deserialization.
Can be registered with a Jackson
ObjectMapper to activate
the Encrypted annotation.An immutable representation of the
EventingFunction stored or to be stored on the server.This builder allows to customize the properties of the eventing function.
The bucket access policy for the bucket binding.
Represents a bucket binding of an eventing function.
Represents a constant binding of an eventing function.
Describes from where in the DCP stream the function should start.
The deployment status of the eventing function.
A keyspace represents a triple of bucket, scope and collection.
Defines the function language compatibility level.
Specifies the log level used when logging out of the eventing function.
Performs management operations on
EventingFunctions.The processing status of the eventing function.
The compound status an eventing function can be in at any given point in time.
Abstract interface for all possible URL Binding authentication mechanisms.
Uses HTTP Basic authentication for the URL binding.
Uses Bearer authentication for the URL binding.
Uses HTTP Digest authentication for the URL binding.
Represents a URL binding of an eventing function.
Allows configuring properties for the
EventingFunctionUrlBinding.No authentication for a URL binding is used.
Contains the status of all eventing functions stored on the server.
The eviction policy for a bucket.
Result returned from an exists KeyValue operation.
Allows to customize the behavior of the eventing functions status operation.
A FTS query which allows to match geo bounding boxes.
A FTS query which allows to match on geo distances.
A search query which allows to match inside a geo polygon.
Allows customizing how datasets are loaded.
Allows customizing how analytics dataverses are loaded.
Allows to customize the behavior of the eventing function get all operation.
Customizes how indexes are loaded.
Allows customizing how query indexes are loaded.
Allows to customize the behavior of the get all scopes operation.
Allows to customize the behavior of the eventing function get operation.
Allows customizing how the analytics links are loaded.
Allows to customize a get request.
Allows customizing how pending mutations are loaded.
Extends GetResult to include additional information for get-from-replica style calls.
Returned from all kinds of KeyValue Get operation to fetch a document or a subset of it.
Allows to customize the behavior of the get scope operation.
Enumeration of the highlighting styles recognized by the FTS engine.
The body of a POST or PUT request.
Specifies the path for an HTTP request.
HTTP status code and response content.
Specifies which Couchbase service should receive the request.
An intention to perform a SubDocument increment operation.
Modifies properties of the increment operation.
An intention to perform a SubDocument insert operation.
A serializer backed by a user-provided Jackson
ObjectMapper.Represents a JSON array that can be stored and loaded from Couchbase Server.
Represents the JSON form of "NULL".
Represents a JSON object that can be stored and loaded from Couchbase Server.
A view of a Couchbase
JsonObject for reading and writing encrypted fields.The
JsonSerializer handles the serialization and deserialization of raw json data into java objects.Represents a JSON value (either a
JsonObject or a JsonArray.Can be registered with a Jackson
ObjectMapper
to add support for Couchbase JsonObject and JsonArray.Wraps another serializer, intercepting and handling requests to
[de]serialize JsonObject and JsonArray.
Convenience macros to retrieve document metadata using a lookupIn Sub-Document call.
Extends LookupInResult to include additional information for lookupIn-from-replica style calls.
This result is returned from successful KeyValue subdocument lookup responses.
Defines specs to lookup parts in a JSON document.
A FTS query that matches all indexed documents (usually for debugging purposes).
A FTS query that matches 0 document (usually for debugging purposes).
Defines how the individual match terms should be logically concatenated.
A FTS query that matches several given terms (a "phrase"), applying further processing
like analyzers to them.
A FTS query that matches a given term, applying further processing to it
like analyzers, stemming and even
fuzziness.This result is returned from successful KeyValue subdocument mutation responses.
Defines specs to mutate parts in a JSON document.
Internal utility methods for the MutateIn subdoc operation.
Result returned from all kinds of Key-Value mutation operations.
Aggregation of one or more
MutationTokens for specifying
consistency requirements of N1QL or FTS queries.A name-value pair.
Represents a query string or form data.
Helper class to provide direct access on how document IDs are mapped onto nodes.
A facet that categorizes rows into numerical ranges (or buckets) provided by the user.
A FTS query that matches documents on a range of values.
Implementation of a
NumericRangeSearchFacetResult.Allows to customize the behavior of the eventing function pause operation.
A FTS query that matches several terms (a "phrase") as is.
Allows to customize a cluster or bucket level ping operation.
A FTS query that allows for simple matching on a given prefix.
Performs a KV range scan for documents whose IDs start with a certain prefix.
Modifies properties of the prepend operation.
Contains the properties of a Query Index.
Performs management operations on query indexes.
Stores any non-rows results related to the execution of a particular N1QL query.
Query Metrics contains the query result metrics containing counts and timings
Allows customizing various N1QL query options.
Query profiling information received from the server query engine.
The result of a N1QL query, including rows and associated metadata.
The possible values for scan consistency in a N1QL request.
A FTS query that performs a search according to the "query string" syntax.
Represents a single warning returned from the query engine.
Performs a KV range scan to scan between two
ScanTerms.A link of unrecognized type.
This class provides direct access to the various management APIs in a raw (uncommitted) form.
Performs management operations on analytics indexes.
This helper class provides methods that make performing batch operations easy and comfortable.
Allows to perform certain operations on non-JSON documents.
Provides access to a Couchbase bucket in a reactive fashion.
Performs (reactive) management operations on Buckets.
The
Cluster is the main entry point when connecting to a Couchbase cluster using the reactive APIs.The
ReactiveCollection provides sophisticated asynchronous access to all collection APIs.The
ReactiveCollectionManager provides APIs to manage collections and scopes within a bucket.Performs management operations on query indexes at the ReactiveCollection level.
A specialized HTTP client for making requests to Couchbase Server.
Performs management operations on
EventingFunctions.Performs management operations on query indexes.
Reactive result that fetch parts of the N1ql Query responses reactively
The scope identifies a group of collections and allows high application
density as a result.
Performs management operations on
EventingFunctions.The
ReactiveSearchIndexManager allows to manage search index structures in a couchbase cluster.Provides methods to allow an application's transaction logic to read, mutate, insert and delete documents, as well
as commit or rollback the transaction.
An asynchronous version of
Transactions, allowing transactions to be created and run in an asynchronous
manner.Holds a the result of a View request operation if successful.
Represents the read preference for a given replica get operation.
A FTS query that allows for simple matching of regular expressions.
An intention to perform a SubDocument remove operation.
Can be registered with a repackaged Jackson
ObjectMapper to activate
the Encrypted annotation.An intention to perform a SubDocument replace operation.
Allows customizing how the analytics links are replaced.
Allows to customize the behavior of the eventing function resume operation.
Associates a
Role with information about why a user has the role.Indicates why a user has the role.
An analytics link to S3.
Performs a KV range scan using random sampling.
Allows to customize the various range and sampling scan options.
Returned for each found item in a KV Range Scan operation.
A single
ScanTerm identifying either the point to scan from or to scan to.Specifies which documents to include in a KV scan.
The scope identifies a group of collections and allows high application
density as a result.
Performs management operations on
EventingFunctions.The
ScopeSearchIndexManager allows to manage search indexes.The
ScopeSpec describes properties of a scope that can be managed.This transcoder is compatible with the Java SDK 2 "LegacyTranscoder", which makes it usable
back to Java SDK 1 as a result.
A range (or bucket) for a
DateRangeSearchFacetResult.Base class for all FTS facets in querying.
Base interface for all facet results.
A full text search index definition.
The
SearchIndexManager allows to manage search index structures in a couchbase cluster.A range (or bucket) for a
NumericRangeSearchFacetResult.A base class for all FTS query classes.
A SearchRequest is used to perform operations against the Full Text Search (FTS) Couchbase service.
The result of an search query, including hits and associated metadata.
An FTS result row (or hit).
A FTS result row location indicates at which position a given term occurs inside a given field.
A default implementation of a
SearchRowLocations.An enum listing the various consistency levels for FTS searches
that don't need additional parameters (like a mutation token vector).
Base class for all FTS sort options in querying.
Sort by a field in the rows.
Sort by a location and unit in the rows.
Sort by the document ID.
Sort by the hit score.
A range (or bucket) for a
TermSearchFacetResult.This transcoder allows to serialize and deserialize objects if they implement the
Serializable interface.Allows configuring a single-query-transaction.
The storage backend that should be used for a Couchbase Bucket.
Describes how the outer document store semantics on subdoc should act.
A facet that gives the number of occurrences of the most recurring terms in all rows.
A FTS query that matches terms (without further analysis).
A FTS query that matches documents on a range of values.
Implementation of a
TermSearchFacetResult.Provides methods to allow an application's transaction logic to read, mutate, insert and delete documents, as well
as
commit or rollback the transaction.
The transaction expired at the point of trying to commit it.
The transaction could not be fully completed in the configured timeout.
The transaction failed to reach the Committed point.
Operations controlling a transactional get.
Operations controlling a transactional getReplicaFromPreferredServerGroup.
Represents a value fetched from Couchbase, along with additional transactional metadata.
Operations controlling a transactional insert.
A keyspace represents a triple of bucket, scope and collection.
Provides all configurable parameters for a single Couchbase transaction.
Allows customizing various N1QL query options.
The result of a N1QL query executed within a transaction, including rows and associated metadata.
Operations controlling a transactional replace.
Provides some debugging and logging facilities for tracking what happened during a transaction.
The starting point for accessing Couchbase transactions.
Provides all configurable parameters for Couchbase transactions cleanup.
Provides all configurable parameters for Couchbase transactions.
Allows setting a default query configuration for all transactions.
The transcoder is responsible for transcoding KV binary packages between their binary and their java object
representation.
Represents the tuple of encoded value and flags to be used on the wire.
Conveys generic type information at run time.
Allows to customize the behavior of the eventing function undeploy operation.
Allows to customize the behavior of the create collection operation.
Allows to customize the behavior of the update collection operation.
An intention to perform a SubDocument upsert operation.
Allows to customize the behavior of the eventing function upsert operation.
Information sent by the server in response to a "get user(s)" request.
Controls how multiple vector queries are combined.
A VectorSearch allows one or more individual
VectorQuerys to be executed.Options related to executing a
VectorSearch.A view index specification consisting of a 'map' function and optionally a 'reduce' function.
Internal helper to access and convert view requests and responses.
Set the behavior on error for a view query.
Holds Metadata associated with a
ViewResult.Sets the ordering of the view result rows.
Holds a the result of a View request operation if successful.
Sets the staleness requirement for the view query.
Allows to customize the diagnostics report.
Allows customizing how the query indexes are watched.
An FTS query that allows for simple matching using wildcard characters (* and ?).
EvictionPolicyTypeinstead.