Cluster
class Cluster (View source)
Cluster is an object containing functionality for performing cluster level operations against a cluster and for access to buckets.
Methods
Executes an analytics query against the cluster.
Executes a full text search query against the cluster.
Creates a new bucket manager object for managing buckets.
Creates a new user manager object for managing users and groups.
Creates a new query index manager object for managing analytics query indexes.
Creates a new query index manager object for managing N1QL query indexes.
Creates a new search index manager object for managing search query indexes.
Details
__construct(string $connstr, ClusterOptions $options)
No description
Bucket
bucket(string $name)
Returns a new bucket object.
QueryResult
query(string $statement, QueryOptions $options = null)
Executes a N1QL query against the cluster.
Note: On Couchbase Server versions < 6.5 a bucket must be opened before using query.
AnalyticsResult
analyticsQuery(string $statement, AnalyticsOptions $options = null)
Executes an analytics query against the cluster.
Note: On Couchbase Server versions < 6.5 a bucket must be opened before using analyticsQuery.
SearchResult
searchQuery(string $indexName, SearchQuery $query, SearchOptions $options = null)
Executes a full text search query against the cluster.
Note: On Couchbase Server versions < 6.5 a bucket must be opened before using searchQuery.
BucketManager
buckets()
Creates a new bucket manager object for managing buckets.
UserManager
users()
Creates a new user manager object for managing users and groups.
AnalyticsIndexManager
analyticsIndexes()
Creates a new query index manager object for managing analytics query indexes.
QueryIndexManager
queryIndexes()
Creates a new query index manager object for managing N1QL query indexes.
SearchIndexManager
searchIndexes()
Creates a new search index manager object for managing search query indexes.