class Cluster (View source)

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

Methods

__construct(string $connstr, ClusterOptions $options)

No description

bucket(string $name)

Returns a new bucket object.

query(string $statement, QueryOptions $options = null)

Executes a N1QL query against the cluster.

analyticsQuery(string $statement, AnalyticsOptions $options = null)

Executes an analytics query against the cluster.

searchQuery(string $indexName, SearchQuery $query, SearchOptions $options = null)

Executes a full text search query against the cluster.

buckets()

Creates a new bucket manager object for managing buckets.

users()

Creates a new user manager object for managing users and groups.

analyticsIndexes()

Creates a new query index manager object for managing analytics query indexes.

queryIndexes()

Creates a new query index manager object for managing N1QL query indexes.

searchIndexes()

Creates a new search index manager object for managing search query indexes.

Details

__construct(string $connstr, ClusterOptions $options)

No description

Parameters

string $connstr
ClusterOptions $options

Bucket bucket(string $name)

Returns a new bucket object.

Parameters

string $name

the name of the bucket

Return Value

Bucket

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.

Parameters

string $statement

the N1QL query statement to execute

QueryOptions $options

the options to use when executing the query

Return Value

QueryResult

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.

Parameters

string $statement

the analytics query statement to execute

AnalyticsOptions $options

the options to use when executing the query

Return Value

AnalyticsResult

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.

Parameters

string $indexName

the fts index to use for the query

SearchQuery $query

the search query to execute

SearchOptions $options

the options to use when executing the query

Return Value

SearchResult

BucketManager buckets()

Creates a new bucket manager object for managing buckets.

Return Value

BucketManager

UserManager users()

Creates a new user manager object for managing users and groups.

Return Value

UserManager

AnalyticsIndexManager analyticsIndexes()

Creates a new query index manager object for managing analytics query indexes.

Return Value

AnalyticsIndexManager

QueryIndexManager queryIndexes()

Creates a new query index manager object for managing N1QL query indexes.

Return Value

QueryIndexManager

SearchIndexManager searchIndexes()

Creates a new search index manager object for managing search query indexes.

Return Value

SearchIndexManager