Reference documentation and code samples for the Cloud Bigtable Client class BigtableClient.
Google Cloud Bigtable is Google's NoSQL Big Data database service.
Find more information at the Google Cloud Bigtable Docs.
Example:
use Google\Cloud\Bigtable\BigtableClient;
$bigtable = new BigtableClient();
Namespace
Google \ Cloud \ BigtableMethods
__construct
Create a Bigtable client.
Parameters | |
---|---|
Name | Description |
config |
array
Configuration options. |
↳ projectId |
string
The project ID from the Google Developer's Console. |
↳ apiEndpoint |
string
The address of the API remote host. May optionally include the port, formatted as "
|
↳ credentials |
FetchAuthTokenInterface|CredentialsWrapper
This option should only be used with a pre-constructed Google\Auth\FetchAuthTokenInterface or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. Important: If you are providing a path to a credentials file, or a decoded credentials file as a PHP array, this usage is now DEPRECATED. Providing an unvalidated credential configuration to Google APIs can compromise the security of your systems and data. It is recommended to create the credentials explicitly |
↳ credentialsConfig |
array
Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper. |
↳ disableRetries |
bool
Determines whether or not retries defined by the client configuration should be disabled. Defaults to |
↳ clientConfig |
string|array
Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. |
↳ transport |
string|TransportInterface
The transport used for executing network requests. May be either the string |
↳ transportConfig |
array
Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...] ]; See the |
↳ quotaProject |
string
Specifies a user project to bill for access charges associated with the request. |
↳ pingAndWarm |
bool
EXPERIMENTAL When true, calls the V2\Client\BigtableClient::pingAndWarm() RPC to establish a persistent gRPC channel before making an RPC call. |
table
Returns a table instance which can be used to read rows and to perform insert, update, and delete operations.
Example:
$table = $bigtable->table('my-instance', 'my-table');
Parameters | |
---|---|
Name | Description |
instanceId |
string
The instance ID. |
tableId |
string
The table ID. |
options |
array
Configuration options. |
↳ appProfileId |
string
This value specifies routing for replication. Defaults to the "default" application profile. |
↳ headers |
array
Headers to be passed with each request. |
Returns | |
---|---|
Type | Description |
Table |