How to get bucket name from CouchbaseBucket object in PHP SDK?

moon0326 · March 31, 2018, 11:28am

Hi,

We are finally upgrading our Couchbase SDK to the latest.

I used to get the bucket name from CouchbaseBucket by using reflection since $bucket->manager()->info() was not stable for some reason and it makes network request as far as I understand.

    $reflected = new ReflectionObject($this->bucket);
    $name = $reflected->getProperty('name');
    $name->setAccessible(true);
    $this->bucketName = $name->getValue($this->bucket);

How do I get bucket name from CouchbaseBucket object?

avsej · March 31, 2018, 5:34pm

There is no public API to get the name of the bucket, but as soon as it is not possible to change it for the bucket object, you can keep then in associative array where the name of the bucket would be the key.

In your example, why don’t you just initialize bucketName at the step where you open the bucket?

This is how it is done in Laravel connector:

github.com

ytake/Laravel-Couchbase/blob/master/src/Database/CouchbaseConnection.php#L289


}


/**
 * @param bool $cross
 */
public function crossBucket(bool $cross)
{
    $this->crossBucket = $cross;
}


/**
 * @param string $bucket
 *
 * @return $this
 */
public function bucket(string $bucket)
{
    $this->bucket = $bucket;


    return $this;
}

This is how it is done in Yii2 connector:

github.com

matrozov/yii2-couchbase/blob/master/src/Bucket.php#L27


*
* @package matrozov\couchbase
*/
class Bucket extends BaseObject
{
   /**
    * @var Connection Couchbase database instance
    */
   public $db;


   /**
    * @var string name of this bucket.
    */
   public $name;


   /**
    * @var \Couchbase\Bucket Couchbase bucket instance
    */
   public $bucket;


   /**

moon0326 · April 2, 2018, 7:41pm

Well, I guess it’s another breaking change from Couchbase SDK.

SDK version 2.2.x had “getName” method as you see on https://github.com/couchbase/php-couchbase/blob/v2.2.4/php/src/CouchbaseBucket.class.php#L87

I really have no idea why a public API gets removed in a minor version update.

We are not using a framework specific library.

I can easily pass a new string value along with CouchbaseBucket object, but that just does not look right. It also requires a code change. It’s almost like passing a Person object with name variable in it, but then passing another string value for the name to a class. It’s simply unnecessary and error prone.

avsej · April 5, 2018, 7:26am

@moon0326 you are welcome to review and test this change: http://review.couchbase.org/c/92167/

moon0326 · April 8, 2018, 10:23am

I already wrapped my class to get bucketName method. It sounds like no one is using it anyway and…I don’t see the method in other SDK (node…or .net).