Documentation

Cluster

Cluster is an object containing functionality for performing cluster level operations against a cluster and for access to buckets.

Table of Contents

__construct() mixed
bucket() Returns a new bucket object. Bucket
query() Executes a N1QL query against the cluster. QueryResult
analyticsQuery() Executes an analytics query against the cluster. AnalyticsResult
searchQuery() Executes a full text search query against the cluster. SearchResult
buckets() Creates a new bucket manager object for managing buckets. BucketManager
users() Creates a new user manager object for managing users and groups. UserManager
queryIndexes() Creates a new query index manager object for managing N1QL query indexes. QueryIndexManager
searchIndexes() Creates a new search index manager object for managing search query indexes. SearchIndexManager

Methods

bucket()

Returns a new bucket object.

public bucket( $name : string ) : Bucket
Parameters
$name : string

the name of the bucket

Return values
Bucket

query()

Executes a N1QL query against the cluster.

public query( $statement : string [, $options : QueryOptions = null ] ) : QueryResult

Note: On Couchbase Server versions < 6.5 a bucket must be opened before using query.

Parameters
$statement : string

the N1QL query statement to execute

$options : QueryOptions = null

the options to use when executing the query

Return values
QueryResult

analyticsQuery()

Executes an analytics query against the cluster.

public analyticsQuery( $statement : string [, $options : AnalyticsOptions = null ] ) : AnalyticsResult

Note: On Couchbase Server versions < 6.5 a bucket must be opened before using analyticsQuery.

Parameters
$statement : string

the analytics query statement to execute

$options : AnalyticsOptions = null

the options to use when executing the query

Return values
AnalyticsResult

searchQuery()

Executes a full text search query against the cluster.

public searchQuery( $indexName : string , $query : SearchQuery [, $options : SearchOptions = null ] ) : SearchResult

Note: On Couchbase Server versions < 6.5 a bucket must be opened before using searchQuery.

Parameters
$indexName : string

the fts index to use for the query

$query : SearchQuery

the search query to execute

$options : SearchOptions = null

the options to use when executing the query

Return values
SearchResult

Search results