Reference documentation and code samples for the Cloud Bigtable V2 Client class BigtableClient.
Service Description: Service for reading from and writing to existing Bigtable tables.
This class is currently experimental and may be subject to changes.
Namespace
Google \ Cloud \ Bigtable \ V2 \ ClientMethods
__construct
Constructor.
options
array
Optional. Options for configuring the service API wrapper.
↳ apiEndpoint
string
The address of the API remote host. May optionally include the port, formatted as "
↳ credentials
string|array|FetchAuthTokenInterface|CredentialsWrapper
The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage : In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
↳ 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::build() .
↳ disableRetries
bool
Determines whether or not retries defined by the client configuration should be disabled. Defaults to false
.
↳ 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. By default this settings points to the default client config file, which is provided in the resources folder.
↳ transport
string|TransportInterface
The transport used for executing network requests. May be either the string rest
or grpc
. Defaults to grpc
if gRPC support is detected on the system. Advanced usage
: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface
object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
↳ 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 Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.
↳ clientCertSource
callable
A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.
checkAndMutateRow
Mutates a row atomically based on the output of a predicate Reader filter.
The async variant is Google\Cloud\Bigtable\V2\Client\BaseClient\self::checkAndMutateRowAsync() .
request
Google\Cloud\Bigtable\V2\CheckAndMutateRowRequest
A request to house fields associated with the call.
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
generateInitialChangeStreamPartitions
NOTE: This API is intended to be used by Apache Beam BigtableIO.
Returns the current list of partitions that make up the table's
change stream. The union of partitions will cover the entire keyspace.
Partitions can be read with ReadChangeStream
.
request
Google\Cloud\Bigtable\V2\GenerateInitialChangeStreamPartitionsRequest
A request to house fields associated with the call.
callOptions
array
Optional.
↳ timeoutMillis
int
Timeout to use for this call.
mutateRow
Mutates a row atomically. Cells already present in the row are left
unchanged unless explicitly changed by mutation
.
The async variant is Google\Cloud\Bigtable\V2\Client\BaseClient\self::mutateRowAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
mutateRows
Mutates multiple rows in a batch. Each individual row is mutated atomically as in MutateRow, but the entire batch is not executed atomically.
request
callOptions
array
Optional.
↳ timeoutMillis
int
Timeout to use for this call.
pingAndWarm
Warm up associated instance metadata for this connection.
This call is not required but may be useful for connection keep-alive.
The async variant is Google\Cloud\Bigtable\V2\Client\BaseClient\self::pingAndWarmAsync() .
request
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
readChangeStream
NOTE: This API is intended to be used by Apache Beam BigtableIO.
Reads changes from a table's change stream. Changes will reflect both user-initiated mutations and mutations that are caused by garbage collection.
request
Google\Cloud\Bigtable\V2\ReadChangeStreamRequest
A request to house fields associated with the call.
callOptions
array
Optional.
↳ timeoutMillis
int
Timeout to use for this call.
readModifyWriteRow
Modifies a row atomically on the server. The method reads the latest existing timestamp and value from the specified columns and writes a new entry based on pre-defined read/modify/write rules. The new value for the timestamp is the greater of the existing timestamp or the current server time. The method returns the new contents of all modified cells.
The async variant is Google\Cloud\Bigtable\V2\Client\BaseClient\self::readModifyWriteRowAsync() .
request
Google\Cloud\Bigtable\V2\ReadModifyWriteRowRequest
A request to house fields associated with the call.
callOptions
array
Optional.
↳ retrySettings
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.
readRows
Streams back the contents of all requested rows in key order, optionally applying the same Reader filter to each. Depending on their size, rows and cells may be broken up across multiple responses, but atomicity of each row will still be preserved. See the ReadRowsResponse documentation for details.
request
callOptions
array
Optional.
↳ timeoutMillis
int
Timeout to use for this call.
sampleRowKeys
Returns a sample of row keys in the table. The returned row keys will delimit contiguous sections of the table of approximately equal size, which can be used to break up the data for distributed tasks like mapreduces.
request
callOptions
array
Optional.
↳ timeoutMillis
int
Timeout to use for this call.
checkAndMutateRowAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
mutateRowAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
pingAndWarmAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
readModifyWriteRowAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
static::instanceName
Formats a string containing the fully-qualified path to represent a instance resource.
project
string
instance
string
string
static::tableName
Formats a string containing the fully-qualified path to represent a table resource.
project
string
instance
string
table
string
string
static::parseName
Parses a formatted name string and returns an associative array of the components in the name.
The following name formats are supported: Template: Pattern
- instance: projects/{project}/instances/{instance}
- table: projects/{project}/instances/{instance}/tables/{table}
The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.
formattedName
string
The formatted name string
template
string
Optional name of template to match
array
