Cloud Bigtable V2 Client - Class CreateTableRequest (2.5.0)

Version 2.5.0

• 2.6.1 (latest)
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.1
• 2.1.0
• 2.0.1
• 1.32.1
• 1.31.1
• 1.30.0
• 1.29.2
• 1.28.3
• 1.27.0
• 1.26.2
• 1.25.0
• 1.24.1
• 1.23.0
• 1.22.2
• 1.21.1
• 1.20.3

Reference documentation and code samples for the Cloud Bigtable V2 Client class CreateTableRequest.

Request message for google.bigtable.admin.v2.BigtableTableAdmin.CreateTable

Generated from protobuf message google.bigtable.admin.v2.CreateTableRequest

Namespace

Google \ Cloud \ Bigtable \ Admin \ V2

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ parent	string Required. The unique name of the instance in which to create the table. Values are of the form projects/{project}/instances/{instance}.
↳ table_id	string Required. The name by which the new table should be referred to within the parent instance, e.g., foobar rather than {parent}/tables/foobar. Maximum 50 characters.
↳ table	Google\Cloud\Bigtable\Admin\V2\Table Required. The Table to create.
↳ initial_splits	array<Google\Cloud\Bigtable\Admin\V2\CreateTableRequest\Split> The optional list of row keys that will be used to initially split the table into several tablets (tablets are similar to HBase regions). Given two split keys, s1 and s2, three tablets will be created, spanning the key ranges: [, s1), [s1, s2), [s2, ). Example: * Row keys := ["a", "apple", "custom", "customer_1", "customer_2", "other", "zz"] * initial_split_keys := ["apple", "customer_1", "customer_2", "other"] * Key assignment: - Tablet 1 [, apple) => {"a"}. - Tablet 2 [apple, customer_1) => {"apple", "custom"}. - Tablet 3 [customer_1, customer_2) => {"customer_1"}. - Tablet 4 [customer_2, other) => {"customer_2"}. - Tablet 5 [other, ) => {"other", "zz"}.

getParent

Required. The unique name of the instance in which to create the table.

Values are of the form projects/{project}/instances/{instance}.

Returns
Type	Description
string

setParent

Required. The unique name of the instance in which to create the table.

Values are of the form projects/{project}/instances/{instance}.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getTableId

Required. The name by which the new table should be referred to within the parent instance, e.g., foobar rather than {parent}/tables/foobar.

Maximum 50 characters.

Returns
Type	Description
string

setTableId

Required. The name by which the new table should be referred to within the parent instance, e.g., foobar rather than {parent}/tables/foobar.

Maximum 50 characters.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getTable

Required. The Table to create.

Returns
Type	Description
Google\Cloud\Bigtable\Admin\V2\Table|null

hasTable

clearTable

setTable

Required. The Table to create.

Parameter
Name	Description
var	Google\Cloud\Bigtable\Admin\V2\Table

Returns
Type	Description
$this

getInitialSplits

The optional list of row keys that will be used to initially split the table into several tablets (tablets are similar to HBase regions).

Given two split keys, s1 and s2, three tablets will be created, spanning the key ranges: [, s1), [s1, s2), [s2, ). Example:

• Row keys := ["a", "apple", "custom", "customer_1", "customer_2", "other", "zz"]
• initial_split_keys := ["apple", "customer_1", "customer_2", "other"]
• Key assignment:
  • Tablet 1 [, apple) => {"a"}.
  • Tablet 2 [apple, customer_1) => {"apple", "custom"}.
  • Tablet 3 [customer_1, customer_2) => {"customer_1"}.
  • Tablet 4 [customer_2, other) => {"customer_2"}.
  • Tablet 5 [other, ) => {"other", "zz"}.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setInitialSplits

The optional list of row keys that will be used to initially split the table into several tablets (tablets are similar to HBase regions).

Given two split keys, s1 and s2, three tablets will be created, spanning the key ranges: [, s1), [s1, s2), [s2, ). Example:

• Row keys := ["a", "apple", "custom", "customer_1", "customer_2", "other", "zz"]
• initial_split_keys := ["apple", "customer_1", "customer_2", "other"]
• Key assignment:
  • Tablet 1 [, apple) => {"a"}.
  • Tablet 2 [apple, customer_1) => {"apple", "custom"}.
  • Tablet 3 [customer_1, customer_2) => {"customer_1"}.
  • Tablet 4 [customer_2, other) => {"customer_2"}.
  • Tablet 5 [other, ) => {"other", "zz"}.

Parameter
Name	Description
var	array<Google\Cloud\Bigtable\Admin\V2\CreateTableRequest\Split>

Returns
Type	Description
$this

static::build

Parameters
Name	Description
parent	string Required. The unique name of the instance in which to create the table. Values are of the form projects/{project}/instances/{instance}. Please see Google\Cloud\Bigtable\Admin\V2\BigtableTableAdminClient::instanceName() for help formatting this field.
tableId	string Required. The name by which the new table should be referred to within the parent instance, e.g., foobar rather than {parent}/tables/foobar. Maximum 50 characters.
table	Google\Cloud\Bigtable\Admin\V2\Table Required. The Table to create.

Returns
Type	Description
Google\Cloud\Bigtable\Admin\V2\CreateTableRequest