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
Methods
__construct
Constructor.
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
↳ 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}
.
string
setParent
Required. The unique name of the instance in which to create the table.
Values are of the form projects/{project}/instances/{instance}
.
var
string
$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.
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.
var
string
$this
getTable
Required. The Table to create.
hasTable
clearTable
setTable
Required. The Table to create.
$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"}.
- Tablet 1
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"}.
- Tablet 1
$this
