N1qlQuery missing options in stub

srm · March 17, 2017, 9:47am

According to this post : PHP SDK: Running query against 2 buckets

N1qlQuery have a public property options, but nothing in this stub : https://github.com/JetBrains/phpstorm-stubs/blob/master/couchbase/couchbase.php#L1646

avsej · March 17, 2017, 9:58am

Accessing options was temporary solution, and now the library moving towards single authenticator container. Stubs refer to code example here:

github.com

JetBrains/phpstorm-stubs/blob/master/couchbase/couchbase.php#L1697


     *   Getting Views Information
     */
    public function custom($customParameters) {}
}


/**
 * Represents spatial Couchbase Map/Reduce View query
 *
 * @see \Couchbase\Bucket::query()
 * @see \Couchbase\ViewQuery
 * @see https://developer.couchbase.com/documentation/server/current/architecture/querying-geo-data-spatial-views.html
 *   Querying Geographic Data with Spatial Views
 * @see https://developer.couchbase.com/documentation/server/current/rest-api/rest-views-get.html
 *   Getting Views Information
 * @see https://developer.couchbase.com/documentation/server/current/views/sv-query-parameters.html
 *   Querying spatial views
 */
class SpatialViewQuery implements ViewQueryEncodable {
    /** @ignore */
    final private function __construct() {}

The rendered documentation accessible here: http://docs.couchbase.com/sdk-api/couchbase-php-client-2.3.0/classes/Couchbase.N1qlQuery.html#method_crossBucket

Example source here:

github.com

couchbase/php-couchbase/blob/master/examples/api/couchbase.N1qlQuery.crossBucket.php

<?php
$authenticator = new \Couchbase\ClassicAuthenticator();
$authenticator->bucket('people', 'secret');
$authenticator->bucket('orders', '123456');

$cluster = new \Couchbase\Cluster("couchbase://localhost");
$cluster->authenticate($authenticator);

$bucket = $cluster->openBucket('orders');

$query = \Couchbase\N1qlQuery::fromString(
    "SELECT * FROM `orders` JOIN `people` ON KEYS `orders`.person_id ORDER BY `orders`.name");
$query->consistency(\Couchbase\N1qlQuery::REQUEST_PLUS);
$query->crossBucket(true);

$res = $bucket->query($query);
// $res inludes rows from orders and people buckets