Documentation

Application

Interfaces, Classes, Traits and Enums

AnalyticsScanConsistency
Set of values for the scan consistency level of an analytics query.
Authenticator
BinaryCollectionInterface
BucketInterface
ClusterInterface
CollectionInterface
ConfigProfile
Provides an interface for new config profiles
DurabilityLevel
An object which contains levels of durability that can be enforced when using mutation operations.
LookupInSpec
LookupInSpec is an interface for providing subdocument lookup operations.
AnalyticsEncryptionLevel
AnalyticsLink
AnalyticsLinkType
AuthDomain
BucketType
CompressionMode
ConflictResolutionType
EvictionPolicy
QueryIndexType
StorageBackend
Meter
Providers an interface to create value recorders for recording metrics.
MutateInSpec
MutateInSpec is an interface for providing subdocument mutation operations.
PersistTo
QueryProfile
Set of values for setting the profile mode of a query.
QueryScanConsistency
Set of values for the scan consistency level of a query.
ReplicateTo
RequestSpan
Represents a span of time an event occurs over.
RequestTracer
Represents a tracer capable of creating trace spans.
ScanType
ScanType is an interface for providing key value scan operations
ScopeInterface
Scope is an object for providing access to collections.
SearchFacet
Common interface for all search facets
SearchHighlightMode
SearchQuery
Common interface for all classes, which could be used as a body of SearchQuery
SearchSort
Base interface for all FTS sort options in querying.
SearchSortMissing
SearchSortMode
SearchSortType
StoreSemantics
An object which contains how to define the document level action to take during a MutateIn operation.
Transcoder
ValueRecorder
Provides an interface for recording values.
ViewConsistency
ViewErrorMode
Interface for retrieving metadata generated during view queries.
ViewOrdering
AnalyticsMetaData
Interface for retrieving metadata such as errors and metrics generated during analytics queries.
AnalyticsOptions
AnalyticsResult
Interface for retrieving results from analytics queries.
AnalyticsWarning
Set of warning or error messages returned by an analytics query.
AppendOptions
BinaryCollection
BinaryCollection is an object containing functionality for performing KeyValue operations against the server with binary documents.
BooleanFieldSearchQuery
A FTS query that queries fields explicitly indexed as boolean.
BooleanSearchQuery
A compound FTS query that allows various combinations of sub-queries.
Bucket
Bucket is an object containing functionality for performing bucket level operations against a cluster and for access to scopes and collections.
CertificateAuthenticator
Cluster
Cluster is an object containing functionality for performing cluster level operations against a cluster and for access to buckets.
ClusterOptions
ClusterRegistry
Collection
Collection is an object containing functionality for performing KeyValue operations against the server.
ConfigProfiles
Singleton class which stores the registered configuration profiles
ConjunctionSearchQuery
A compound FTS query that performs a logical AND between all its sub-queries (conjunction).
Coordinate
CounterResult
Interface for results created by the counter operation.
CouchbaseList
Implementation of the List backed by JSON document in Couchbase collection
CouchbaseMap
Implementation of the List backed by JSON document in Couchbase collection
CouchbaseQueue
Implementation of the List backed by JSON document in Couchbase collection
CouchbaseSet
Implementation of the List backed by JSON document in Couchbase collection
CouchbaseList
Aggregate of the options for {@link \Couchbase\Datastructures\CouchbaseList}
CouchbaseMap
Aggregate of the options for {@link \Couchbase\Datastructures\CouchbaseList}
CouchbaseQueue
Aggregate of the options for {@link \Couchbase\Datastructures\CouchbaseList}
CouchbaseSet
Aggregate of the options for {@link \Couchbase\Datastructures\CouchbaseList}
DateRangeFacetResult
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).
DateRangeSearchFacet
A facet that categorizes hits inside date ranges (or buckets) provided by the user.
DateRangeSearchQuery
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.
DecrementOptions
DesignDocumentNamespace
DisjunctionSearchQuery
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).
DocIdSearchQuery
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).
AmbiguousTimeoutException
This is a special case of the timeout exception, signaling that the timeout happened with an ambiguous cause.
AuthenticationFailureException
Every exception that has to do with authentication problems should either instantiate or subclass from this type
BucketExistsException
Base exception for exceptions that are thrown originating from Couchbase operations.
BucketNotFlushableException
Base exception for exceptions that are thrown originating from Couchbase operations.
BucketNotFoundException
Base exception for exceptions that are thrown originating from Couchbase operations.
CasMismatchException
Indicates an optimistic locking failure.
CollectionExistsException
Base exception for exceptions that are thrown originating from Couchbase operations.
CollectionNotFoundException
Base exception for exceptions that are thrown originating from Couchbase operations.
CompilationFailureException
The analytics query failed to compile
ConsistencyMismatchException
Base exception for exceptions that are thrown originating from Couchbase operations.
CouchbaseException
Base exception for exceptions that are thrown originating from Couchbase operations.
DatasetExistsException
Base exception for exceptions that are thrown originating from Couchbase operations.
DatasetNotFoundException
The queried dataset is not found on the server.
DataverseExistsException
Base exception for exceptions that are thrown originating from Couchbase operations.
DataverseNotFoundException
Base exception for exceptions that are thrown originating from Couchbase operations.
DecodingFailureException
Raised when provided content could not be successfully decoded.
DeltaInvalidException
Subdocument exception thrown when the delta in an arithmetic operation (eg counter) is invalid. In this SDK, this is equivalent to saying that the delta is zero.
DesignDocumentNotFoundException
Base exception for exceptions that are thrown originating from Couchbase operations.
DocumentExistsException
Indicates an operation failed because the key already exists.
DocumentIrretrievableException
Indicates an operation completed but no successful document was retrievable
DocumentLockedException
Thrown when the server reports a temporary failure that is very likely to be lock-related (like an already locked key or a bad cas used for unlock).
DocumentNotFoundException
Indicates an operation failed because the key does not exist.
DocumentNotJsonException
Subdocument exception thrown when the targeted enclosing document itself is not JSON.
DurabilityAmbiguousException
The synchronous replication durability work can return an ambiguous error (or we timeout waiting for the response, which is effectively the same). Here we know the change is on a majority of replicas, or it's on none.
DurabilityImpossibleException
The given durability requirements are currently impossible to achieve, as not enough configured replicas are currently available.
DurabilityLevelNotAvailableException
This exception is raised when a durability level has been requested that is not available on the server.
DurableWriteInProgressException
Returned if an attempt is made to mutate a key which already has a durable write pending.
DurableWriteReCommitInProgressException
The requested key has a SyncWrite which is being re-committed.
EncodingFailureException
Raised when provided content could not be successfully encoded.
FeatureNotAvailableException
Exception which states that the feature is not available.
GroupNotFoundException
Base exception for exceptions that are thrown originating from Couchbase operations.
IndexExistsException
Base exception for exceptions that are thrown originating from Couchbase operations.
IndexFailureException
Indicates an operation failed because there has been an issue with the query planner or similar.
IndexNotFoundException
Base exception for exceptions that are thrown originating from Couchbase operations.
IndexNotReadyException
Base exception for exceptions that are thrown originating from Couchbase operations.
InternalServerFailureException
Base exception for exceptions that are thrown originating from Couchbase operations.
InvalidArgumentException
Base exception for exceptions that are thrown originating from Couchbase operations.
JobQueueFullException
Indicates the analytics server job queue is full
LinkExistsException
Base exception for exceptions that are thrown originating from Couchbase operations.
LinkNotFoundException
Base exception for exceptions that are thrown originating from Couchbase operations.
NumberTooBigException
Subdocument exception thrown when existing number value in document is too big.
ParsingFailureException
Base exception for exceptions that are thrown originating from Couchbase operations.
PathExistsException
Subdocument exception thrown when a path already exists and it shouldn't
PathInvalidException
Subdocument exception thrown when path has a syntax error, or path syntax is incorrect for the operation (for example, if operation requires an array index).
PathMismatchException
Subdocument exception thrown when the path structure conflicts with the document structure (for example, if a path mentions foo.bar[0].baz, but foo.bar is actually a JSON object).
PathNotFoundException
Subdocument exception thrown when a path does not exist in the document. The exact meaning of path existence depends on the operation and inputs.
PathTooBigException
Base exception for exceptions that are thrown originating from Couchbase operations.
PathTooDeepException
Subdocument exception thrown when path is too deep to parse. Depth of a path is determined by how many components (or levels) it contains.
PlanningFailureException
Indicates an operation failed because there has been an issue with the query planner.
PreparedStatementFailureException
Indicates an operation failed because there has been an issue with query prepared statements.
RequestCanceledException
Base exception for exceptions that are thrown originating from Couchbase operations.
ScopeExistsException
Base exception for exceptions that are thrown originating from Couchbase operations.
ScopeNotFoundException
Base exception for exceptions that are thrown originating from Couchbase operations.
ServiceNotAvailableException
Base exception for exceptions that are thrown originating from Couchbase operations.
TemporaryFailureException
Base exception for exceptions that are thrown originating from Couchbase operations.
TimeoutException
The {Timeout} signals that an operation timed out before it could be completed.
TransactionCommitAmbiguousException
Base exception for exceptions that are thrown originating from Couchbase operations.
TransactionException
Base exception for exceptions that are thrown originating from Couchbase operations.
TransactionExpiredException
Base exception for exceptions that are thrown originating from Couchbase operations.
TransactionFailedException
Base exception for exceptions that are thrown originating from Couchbase operations.
TransactionOperationFailedException
Base exception for exceptions that are thrown originating from Couchbase operations.
UnambiguousTimeoutException
This is a special case of the timeout exception, signaling that the timeout happened with no ambiguous cause.
UnsupportedOperationException
Base exception for exceptions that are thrown originating from Couchbase operations.
UserExistsException
Base exception for exceptions that are thrown originating from Couchbase operations.
UserNotFoundException
Base exception for exceptions that are thrown originating from Couchbase operations.
ValueInvalidException
Subdocument exception thrown when the provided value cannot be inserted at the given path.
ValueTooDeepException
Subdocument exception thrown when proposed value would make the document too deep to parse.
ValueTooLargeException
Thrown when the request is too big for some reason.
ViewNotFoundException
The queried view is not found on the server
XattrCannotModifyVirtualAttributeException
Subdocument exception thrown when the virtual attribute cannot be modified.
XattrInvalidKeyComboException
Subdocument exception thrown when more than one xattr key has been requested.
XattrUnknownMacroException
Subdocument exception thrown when a macro has been requested which is not recognised by the server.
XattrUnknownVirtualAttributeException
Subdocument exception thrown when a virtual attribute has been requested which is not recognised by the server.
ExistsOptions
ExistsResult
Base interface for all results generated by KV operations.
GeoBoundingBoxSearchQuery
A FTS query which allows to match geo bounding boxes.
GeoDistanceSearchQuery
A FTS query that finds all matches from a given location (point) within the given distance.
GeoPolygonQuery
A FTS query that finds all matches within the given polygon area.
GetAllReplicasOptions
GetAndLockOptions
GetAndTouchOptions
GetAnyReplicaOptions
GetOptions
GetReplicaResult
Interface for results created by the getReplica operation.
GetResult
Interface for results created by the get operation.
IncrementOptions
InsertOptions
JsonTranscoder
LoggingMeter
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.
LoggingMeterOptions
LookupCountSpec
Indicates to retrieve the count of array items or dictionary keys within a path in a document.
LookupExistsSpec
Indicates to check if a path exists in a document.
LookupGetFullSpec
Indicates to retreive a whole document.
LookupGetSpec
Indicates a path for a value to be retrieved from a document.
LookupInAllReplicasOptions
LookupInAnyReplicaOptions
LookupInMacro
LookupInOptions
LookupInReplicaResult
Interface for results created by the lookupInReplica operation.
LookupInResult
Interface for results created by the lookupIn operation.
AllowQueryingSearchIndexOptions
AnalyticsIndexManager
AnalyzeDocumentOptions
AzureBlobExternalAnalyticsLink
BucketManager
BucketSettings
BuildQueryIndexesOptions
ChangePasswordOptions
CollectionManager
CollectionQueryIndexManager
CollectionSpec
ConnectAnalyticsLinkOptions
CouchbaseRemoteAnalyticsLink
CreateAnalyticsDatasetOptions
CreateAnalyticsDataverseOptions
CreateAnalyticsIndexOptions
CreateAnalyticsLinkOptions
CreateBucketOptions
CreateCollectionOptions
CreateQueryIndexOptions
CreateQueryPrimaryIndexOptions
CreateScopeOptions
DesignDocument
DisallowQueryingSearchIndexOptions
DisconnectAnalyticsLinkOptions
DropAnalyticsDatasetOptions
DropAnalyticsDataverseOptions
DropAnalyticsIndexOptions
DropAnalyticsLinkOptions
DropBucketOptions
DropCollectionOptions
DropGroupOptions
DropQueryIndexOptions
DropQueryPrimaryIndexOptions
DropScopeOptions
DropSearchIndexOptions
DropUserOptions
EncryptionSettings
FlushBucketOptions
FreezePlanSearchIndexOptions
GetAllBucketsOptions
GetAllGroupsOptions
GetAllQueryIndexesOptions
GetAllScopesOptions
GetAllSearchIndexesOptions
GetAllUsersOptions
GetAnalyticsLinksOptions
GetBucketOptions
GetGroupOptions
GetIndexedSearchIndexOptions
GetRolesOptions
GetSearchIndexOptions
GetUserOptions
Group
Origin
PauseIngestSearchIndexOptions
QueryIndex
QueryIndexManager
ReplaceAnalyticsLinkOptions
ResumeIngestSearchIndexOptions
Role
RoleAndDescription
RoleAndOrigin
S3ExternalAnalyticsLink
ScopeSpec
SearchIndex
SearchIndexManager
UnfreezePlanSearchIndexOptions
UpdateBucketOptions
UpsertGroupOptions
UpsertSearchIndexOptions
UpsertUserOptions
User
UserAndMetadata
UserManager
View
ViewIndexManager
WatchQueryIndexesOptions
MatchAllSearchQuery
A FTS query that matches all indexed documents (usually for debugging purposes).
MatchNoneSearchQuery
A FTS query that matches 0 document (usually for debugging purposes).
MatchPhraseSearchQuery
A FTS query that matches several given terms (a "phrase"), applying further processing like analyzers to them.
MatchSearchQuery
A FTS query that matches a given term, applying further processing to it like analyzers, stemming and even #fuzziness(int).
MutateArrayAddUniqueSpec
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.
MutateArrayAppendSpec
Indicates to append a value to an array at a path in a document.
MutateArrayInsertSpec
Indicates to insert a value into an array at a path in a document.
MutateArrayPrependSpec
Indicates to prepend a value to an array at a path in a document.
MutateCounterSpec
Indicates to increment or decrement a counter value at a path in a document.
MutateInOptions
MutateInResult
Results created by the mutateIn operation.
MutateInsertSpec
Indicates to insert a value at a path in a document.
MutateRemoveSpec
Indicates to remove a value at a path in a document.
MutateReplaceSpec
Indicates to replace a value at a path if it doesn't exist in a document.
MutateUpsertSpec
Indicates to replace a value at a path if it doesn't exist, otherwise create the path, in a document.
MutationResult
Interface for results created by operations that perform mutations.
MutationState
MutationState is an object which holds and aggregates mutation tokens across operations.
MutationToken
An object which contains meta information of the document needed to enforce query consistency.
NoopMeter
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.
NoopTracer
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.
NumericRangeFacetResult
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).
NumericRangeSearchFacet
A facet that categorizes hits into numerical ranges (or buckets) provided by the user.
NumericRangeSearchQuery
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.
PasswordAuthenticator
PhraseSearchQuery
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.
PrefixScan
A PrefixScan selects every document whose ID starts with a certain prefix
PrefixSearchQuery
A FTS query that allows for simple matching on a given prefix.
PrependOptions
QueryMetaData
Interface for retrieving metadata such as errors and metrics generated during N1QL queries.
QueryOptions
QueryResult
QueryResult is an object for retrieving results from N1QL queries.
QueryStringSearchQuery
A FTS query that performs a search according to the "string query" syntax.
QueryWarning
Set of warning or error messages returned by a query.
RangeScan
A RangeScan performs a scan on a range of keys with the range specified through a start and end ScanTerm
RawBinaryTranscoder
RawJsonTranscoder
RawStringTranscoder
RegexpSearchQuery
A FTS query that allows for simple matching of regular expressions.
RemoveOptions
ReplaceOptions
Result
Base interface for all results generated by KV operations.
SamplingScan
A SamplingScan performs a scan on a random sampling of keys with the sampling bounded by a limit.
ScanOptions
ScanResult
Interface for results created by the scan operation.
ScanResults
Interface for ScanResults containing the iterator which streams back the ScanResults
ScanTerm
Scope
Scope is an object for providing access to collections.
SearchFacetResult
Class representing facet results.
SearchMetaData
Class for retrieving metadata such as error counts and metrics generated during search queries.
SearchOptions
SearchResult
Class for retrieving results from search queries.
SearchSortField
Sort by a field in the hits.
SearchSortGeoDistance
Sort by a location and unit in the hits.
SearchSortId
Sort by the document identifier.
SearchSortScore
Sort by the hit score.
ServiceType
TermFacetResult
A range (or bucket) for a term search facet result.
TermRangeSearchQuery
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.
TermSearchFacet
A facet that gives the number of occurrences of the most recurring terms in all hits.
TermSearchQuery
A facet that gives the number of occurrences of the most recurring terms in all hits.
ThresholdLoggingOptions
ThresholdLoggingTracer
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.
TouchOptions
TransactionAttemptContext
TransactionGetResult
Base interface for all results generated by KV operations.
TransactionKeyspace
TransactionOptions
TransactionQueryOptions
TransactionResult
Transactions
TransactionsCleanupConfiguration
TransactionsConfiguration
TransactionsQueryConfiguration
TranscoderFlags
UnlockOptions
UpsertOptions
Deprecations
ViewMetaData
Class for retrieving metadata generated during view queries.
ViewOptions
ViewResult
Class for retrieving results from view queries.
ViewRow
Object for accessing a row returned as a part of the results from a viery query.
WanDevelopmentProfile
Definition of the wan_development profile from RFC-0074
WildcardSearchQuery
A FTS query that allows for simple matching using wildcard characters (* and ?).

Table of Contents

couchbase_autoload()  : mixed
Couchbase's PHP autoloader

Functions

couchbase_autoload()

Couchbase's PHP autoloader

couchbase_autoload(mixed $className) : mixed
Parameters
$className : mixed
Return values
mixed

Search results