1. class
  2. Couchbase
  3. \
  4. Scope

Scope

class Scope (View source)

Scope is an object for providing access to collections.

Methods

__construct(Bucket $bucket, string $name)

No description

string
name()

Returns the name of the scope.

Collection
collection(string $name)

Returns a new Collection object representing the collection specified.

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

Executes a N1QL query against the cluster with scopeName set implicitly.

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

Executes an analytics query against the cluster with scopeName set implicitly.

Details

at line 1896
__construct(Bucket $bucket, string $name)

No description

Parameters

Bucket $bucket
string $name

at line 1903
string name()

Returns the name of the scope.

Return Value

string

at line 1911
Collection collection(string $name)

Returns a new Collection object representing the collection specified.

Parameters

string $name

the name of the collection

Return Value

Collection

at line 1920
QueryResult query(string $statement, QueryOptions $options = null)

Executes a N1QL query against the cluster with scopeName set implicitly.

Parameters

string $statement

the N1QL query statement to execute
QueryOptions $options

the options to use when executing the query

Return Value

QueryResult

at line 1929
AnalyticsResult analyticsQuery(string $statement, AnalyticsOptions $options = null)

Executes an analytics query against the cluster with scopeName set implicitly.

Parameters

string $statement

the analytics query statement to execute
AnalyticsOptions $options

the options to use when executing the query

Return Value

AnalyticsResult