\CouchbaseSpatialViewQuery

Represents spatial Couchbase Map/Reduce View query

Summary

Methods
Properties
Constants
encode()
limit()
skip()
consistency()
order()
bbox()
startRange()
endRange()
custom()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

encode()

encode() : array

Returns associative array, representing the View query.

Returns

array —

object which is ready to be serialized.

limit()

limit(integer  $limit) : \Couchbase\SpatialViewQuery

Limits the result set to a specified number rows.

Parameters

integer $limit

maximum number of records in the response

Returns

\Couchbase\SpatialViewQuery

skip()

skip(integer  $skip) : \Couchbase\SpatialViewQuery

Skips a number o records rom the beginning of the result set

Parameters

integer $skip

number of records to skip

Returns

\Couchbase\SpatialViewQuery

consistency()

consistency(integer  $consistency) : \Couchbase\SpatialViewQuery

Specifies the mode of updating to perorm before and after executing the query

Parameters

integer $consistency

use constants UPDATE_BEFORE, UPDATE_NONE, UPDATE_AFTER

Returns

\Couchbase\SpatialViewQuery

order()

order(integer  $order) : \Couchbase\SpatialViewQuery

Orders the results by key as specified

Parameters

integer $order

use contstants ORDER_ASCENDING, ORDER_DESCENDING

Returns

\Couchbase\SpatialViewQuery

bbox()

bbox(array  $bbox) : \Couchbase\SpatialViewQuery

Specifies the bounding box to search within.

Note, using bbox() is discouraged, startRange/endRange is more flexible and should be preferred.

Parameters

array $bbox

bounding box coordinates expressed as a list of numeric values

Returns

\Couchbase\SpatialViewQuery

startRange()

startRange(array  $range) : \Couchbase\SpatialViewQuery

Specify start range for query

Parameters

array $range

Returns

\Couchbase\SpatialViewQuery

endRange()

endRange(array  $range) : \Couchbase\SpatialViewQuery

Specify end range for query

Parameters

array $range

Returns

\Couchbase\SpatialViewQuery

custom()

custom(array  $customParameters) 

Specifies custom options to pass to the server.

Note that these options are expected to be already encoded.

Parameters

array $customParameters

parameters