_CouchbaseDefaultViewQuery

Extends \CouchbaseViewQuery

Represents a regular view query to perform against the server. Note that this object should never be instantiated directly, but instead through the CouchbaseViewQuery::from method.

package	Couchbase

Methods

Orders the results by key as specified.

order(mixed $order) : $this

throws

Arguments

$order

mixed

Response

$this

Specifies a reduction function to apply to the index.

reduce(mixed $reduce) : $this

Arguments

$reduce

mixed

Response

$this

Specifies the level of grouping to use on the results.

group(mixed $group_level) : $this

Arguments

$group_level

mixed

Response

$this

Specifies a specific key to return from the index.

key(mixed $key) : $this

Arguments

$key

mixed

Response

$this

Specifies a list of keys to return from the index.

keys(mixed $keys) : $this

Arguments

$keys

mixed

Response

$this

Specifies a range of keys to return from the index.

range(mixed $start = NULL, mixed $end = NULL, bool $inclusive_end = false) : $this

Arguments

$start

mixed

$end

mixed

$inclusive_end

bool

Response

$this

Specifies a range of document ids to return from the index.

id_range(null $start = NULL, null $end = NULL) : $this

Arguments

$start

null

$end

null

Response

$this

Generates the view query as it will be passed to the server.

toString() : string

Response

string

Creates a new Couchbase ViewQuery instance for performing a view query.

from(mixed $ddoc, mixed $name) : \_CouchbaseDefaultViewQuery

inherited static

Arguments

$ddoc

mixed

The name of the design document to query.

$name

mixed

The name of the view to query.

Response

\_CouchbaseDefaultViewQuery

Creates a new Couchbase ViewQuery instance for performing a spatial query.

fromSpatial(mixed $ddoc, mixed $name) : \_CouchbaseSpatialViewQuery

inherited static

Arguments

$ddoc

mixed

The name of the design document to query.

$name

mixed

The name of the view to query.

Response

\_CouchbaseSpatialViewQuery

Specifies the mode of updating to perform before and after executing this query.

stale(mixed $stale) : $this

inherited

throws

Arguments

$stale

mixed

Response

$this

Skips a number of records from the beginning of the result set.

skip(mixed $skip) : $this

inherited

Arguments

$skip

mixed

Response

$this

Limits the result set to a restricted number of results.

limit(mixed $limit) : $this

inherited

Arguments

$limit

mixed

Response

$this

Specifies custom options to pass to the server. Note that these options are expected to be already encoded.

custom(mixed $opts) : $this

inherited

Arguments

$opts

mixed

Response

$this

Constants

UPDATE_BEFORE

UPDATE_BEFORE

inherited

UPDATE_NONE

UPDATE_NONE

inherited

UPDATE_AFTER

UPDATE_AFTER

inherited

ORDER_ASCENDING

ORDER_ASCENDING

inherited

ORDER_DESCENDING

ORDER_DESCENDING

inherited