README

Idiomatic PHP client for Google Cloud Bigtable.

• API Documentation

NOTE: This repository is part of Google Cloud PHP. Any support requests, bug reports, or development contributions should be directed to that project.

A high performance NoSQL database service for large analytical and operational workloads.

Installation

To begin, install the preferred dependency manager for PHP, Composer.

Now install this component:

$ composer require google/cloud-bigtable

This component supports both REST over HTTP/1.1 and gRPC. In order to take advantage of the benefits offered by gRPC (such as streaming methods) please see our gRPC installation guide.

Notable Client Differences

The handwritten client offered by this package differs from the others in google-cloud-php in that it more directly wraps our generated clients. This means some of the idioms and configuration options you are used to may differ slightly. The most notable differences are outlined below:

• A key file is now provided through the credentials configuration option as opposed to either keyFile or keyFilePath.
• There is now more granular control over retry logic. Please see the bigtable_client_config.json file for an example of the configuration which can be passed into the client at construction time.
• Exceptions triggered at the network level utilize the base class Google\ApiCore\ApiException as opposed to Google\Cloud\Core\ServiceException.
• The authHttpHandler and httpHandler client configuration options are now provided through $credentialsConfig['authHttpHandler'] and $transportConfig['httpHandler'], respectively. Additionally, please note the httpHandler should now return an implementation of Guzzle's PromiseInterface.

Authentication

Please see our Authentication guide for more information on authenticating your client. Once authenticated, you'll be ready to start making requests.

When going through the authentication guide, please take note that the handwritten client for this package will more closely follow the conventions outlined for the generated clients.

Sample

use Google\ApiCore\ApiException;
use Google\Cloud\Bigtable\V2\Client\BigtableClient;
use Google\Cloud\Bigtable\V2\PingAndWarmRequest;
use Google\Cloud\Bigtable\V2\PingAndWarmResponse;

// Create a client.
$bigtableClient = new BigtableClient();

// Prepare the request message.
$request = (new PingAndWarmRequest())
    ->setName($formattedName);

// Call the API and handle any network failures.
try {
    /** @var PingAndWarmResponse $response */
    $response = $bigtableClient->pingAndWarm($request);
    printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
    printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}

Debugging

Please see our Debugging guide for more information about the debugging tools.

Version

This component is considered GA (generally available). As such, it will not introduce backwards-incompatible changes in any minor or patch releases. We will address issues and requests with the highest priority.

Please see the migration guide to upgrade from V1 of the library to V2.

Next Steps

Take a look at and understand the official documentation.