Couchbase
Classes
Represents a Analytics query (currently experimental support).
BinaryCollection is an object containing functionality for performing KeyValue operations against the server with binary documents.
A FTS query that queries fields explicitly indexed as boolean.
A compound FTS query that allows various combinations of sub-queries.
Represents connection to the Couchbase Server
Provides management capabilities for the Couchbase Bucket
Authenticator based on login/password credentials.
Represents a Couchbase Server Cluster.
Provides management capabilities for a Couchbase Server Cluster
Collection is an object containing functionality for performing KeyValue operations against the server.
A compound FTS query that performs a logical AND between all its sub-queries (conjunction).
A facet that categorizes hits inside date ranges (or buckets) provided by the user.
A FTS query that matches documents on a range of values. At least one bound is required, and the inclusiveness of each bound can be configured.
A compound FTS query that performs a logical OR between all its sub-queries (disjunction). It requires that a minimum of the queries match. The minimum is configurable (default 1).
A FTS query that matches on Couchbase document IDs. Useful to restrict the search space to a list of keys (by using this in a compound query).
Represents Couchbase Document, which stores metadata and the value.
A fragment of a JSON Document returned by the sub-document API.
A FTS query which allows to match geo bounding boxes.
A FTS query that finds all matches from a given location (point) within the given distance.
A FTS query that finds all matches within the given polygon area.
Implements a default meter which logs metrics on a regular basis. Note that to reduce the performance impact of using this meter, this class is not actually used by the SDK, and simply acts as a placeholder which triggers a native implementation to be used instead.
Indicates to retrieve the count of array items or dictionary keys within a path in a document.
Indicates to check if a path exists in a document.
Indicates to retreive a whole document.
Indicates a path for a value to be retrieved from a document.
A builder for subdocument lookups. In order to perform the final set of operations, use the execute() method.
A FTS query that matches all indexed documents (usually for debugging purposes).
A FTS query that matches 0 document (usually for debugging purposes).
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(int).
Indicates to add a value into an array at a path in a document so long as that value does not already exist in the array.
Indicates to append a value to an array at a path in a document.
Indicates to insert a value into an array at a path in a document.
Indicates to prepend a value to an array at a path in a document.
Indicates to increment or decrement a counter value at a path in a document.
A builder for subdocument mutations. In order to perform the final set of operations, use the execute() method.
Indicates to insert a value at a path in a document.
Indicates to remove a value at a path in a document.
Indicates to replace a value at a path if it doesn't exist in a document.
Indicates to replace a value at a path if it doesn't exist, otherwise create the path, in a document.
Container for mutation tokens.
An object which contains meta information of the document needed to enforce query consistency.
Represents N1QL index definition
Represents a N1QL query
Implements a no-op meter which performs no metrics instrumentation. Note that to reduce the performance impact of using this meter, this class is not actually used by the SDK, and simply acts as a placeholder which triggers a native implementation to be used instead.
Implements a no-op tracer which performs no work. Note that to reduce the performance impact of using this tracer, this class is not actually used by the SDK, and simply acts as a placeholder which triggers a native implementation to be used instead.
A facet that categorizes hits into numerical ranges (or buckets) provided by the user.
A FTS query that matches documents on a range of values. At least one bound is required, and the inclusiveness of each bound can be configured.
Authenticator based on RBAC feature of Couchbase Server 5+.
A FTS query that matches several terms (a "phrase") as is. The order of the terms mater and no further processing is applied to them, so they must appear in the index exactly as provided. Usually for debugging purposes, prefer MatchPhraseQuery.
A FTS query that allows for simple matching on a given prefix.
A FTS query that performs a search according to the "string query" syntax.
A FTS query that allows for simple matching of regular expressions.
Scope is an object for providing access to collections.
Represents full text search query
Base class for all FTS sort options in querying.
Sort by a field in the hits.
Sort by a location and unit in the hits.
Sort by the document identifier.
Sort by the hit score.
Represents spatial Couchbase Map/Reduce View query
A FTS query that matches documents on a range of values. At least one bound is required, and the inclusiveness of each bound can be configured.
A facet that gives the number of occurrences of the most recurring terms in all hits.
A facet that gives the number of occurrences of the most recurring terms in all hits.
This implements a basic default tracer which keeps track of operations which falls outside a specified threshold. Note that to reduce the performance impact of using this tracer, this class is not actually used by the SDK, and simply acts as a placeholder which triggers a native implementation to be used instead.
Represents settings for new/updated user.
Represents regular Couchbase Map/Reduce View query
Object for accessing a row returned as a part of the results from a viery query.
A FTS query that allows for simple matching using wildcard characters (* and ?).
Interfaces
Interface for retrieving results from analytics queries.
Interface of authentication containers.
Interface for results created by the counter operation.
A range (or bucket) for a date range facet result. Counts the number of matches that fall into the named range (which can overlap with other user-defined ranges).
An object which contains levels of durability that can be enforced when using mutation operations.
Interface for results created by the exists operation.
Interface for results created by the getReplica operation.
Interface for results created by the get operation.
Interface for results created by the lookupIn operation.
LookupInSpec is an interface for providing subdocument lookup operations.
Providers an interface to create value recorders for recording metrics.
Interface for results created by the mutateIn operation.
MutateInSpec is an interface for providing subdocument mutation operations.
Interface for results created by operations that perform mutations.
An object which contains meta information of the document needed to enforce query consistency.
A range (or bucket) for a numeric range facet result. Counts the number of matches that fall into the named range (which can overlap with other user-defined ranges).
Interface for retrieving metadata such as errors and metrics generated during N1QL queries.
Set of values for setting the profile mode of a query.
Interface for retrieving results from N1QL queries.
Set of values for the scan consistency level of a query.
Represents a span of time an event occurs over.
Represents a tracer capable of creating trace spans.
Base interface for all results generated by KV operations.
Common interface for all search facets
Interface representing facet results.
Interface for retrieving metadata such as error counts and metrics generated during search queries.
Common interface for all classes, which could be used as a body of SearchQuery
Common interface for all classes, which could be used as a body of SearchQuery
Interface for retrieving results from search queries.
Base interface for all FTS sort options in querying.
An object which contains how to define the document level action to take during a MutateIn operation.
A range (or bucket) for a term search facet result.
Provides an interface for recording values.
Interface for retrieving metadata generated during view queries.
Common interface for all View queries
Interface for retrieving results from view queries.
Functions
Decodes value according to Common Flags (RFC-20)
Encodes value according to Common Flags (RFC-20)
Decodes value using \Couchbase\basicDecoderV1.
Returns value as it received from the server without any transformations.
Returns the value, which has been passed and zero as flags and datatype.
Compress input using zlib. Raises Exception when extension compiled without zlib support.
Compress input using zlib. Raises Exception when extension compiled without zlib support.
Exceptions
Thrown for exceptions that originate from analytics operations.
Occurs when authentication has failed.
Occurs when an operation is attempted with bad input.
Base exception for exceptions that are thrown originating from Couchbase operations.
Occurs when the specified bucket does not exist.
Occurs when an operation has been performed with a cas value that does not the value on the server.
Occurs when the specified collection does not exist.
Occurs when the requested document could not be found.
Occurs when the specified durability could not be met for a mutation operation.
Exception represeting all errors generated by the extension
Thrown for exceptions that originate from underlying Http operations.
Occurs when an invalid configuration has been specified for an operation.
Occurs when a sub-document counter operation is performed and the specified delta is not valid.
Occurs when a multi-operation sub-document operation is performed on a soft-deleted document.
Occurs when an attempt is made to insert a document but a document with that key already exists.
Occurs when a mutation operation is attempted against a document that is locked.
Base for exceptions that originate from key value operations
Occurs when various generic network errors occur.
Occurs when a sub-document operation expects a path not to exists, but the path was found in the document.
Occurs when a sub-document operation targets a path which does not exist in the specified document.
Thrown for exceptions that originate from query operations.
Thrown for exceptions that originate from query operations.
Occurs when the specified scope does not exist.
Thrown for exceptions that originate from search operations.
Occurs when the requested service is not available.
Occurs when a subdocument operation could not be completed.
Occurs when an operation has failed for a reason that is temporary.
Occurs when an operation does not receive a response in a timely manner.
Occurs when a document has gone over the maximum size allowed by the server.
Thrown for exceptions that originate from view operations.