Class: Google::Bigtable::Admin::V2::CreateTableRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/bigtable_table_admin.rb

Overview

Request message for BigtableTableAdmin::CreateTable

Defined Under Namespace

Classes: Split

Instance Attribute Summary collapse

Instance Attribute Details

#initial_splits ⇒ Array<Google::Bigtable::Admin::V2::CreateTableRequest::Split>

Returns 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) => "custom".+
    • Tablet 3 +[customer_1, customer_2) => "customer_1".+
    • Tablet 4 +[customer_2, other) => "customer_2".+
    • Tablet 5 +[other, ) => "zz".+

Returns:

  • (Array<Google::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) => "custom".+
      • Tablet 3 +[customer_1, customer_2) => "customer_1".+
      • Tablet 4 +[customer_2, other) => "customer_2".+
      • Tablet 5 +[other, ) => "zz".+


50
51
52
53
54
55
56
 
# File 'lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/bigtable_table_admin.rb', line 50

class CreateTableRequest
  # An initial split point for a newly created table.
  # @!attribute [rw] key
  #   @return [String]
  #     Row key to use as an initial tablet boundary.
  class Split; end
end

#parent ⇒ String

Returns The unique name of the instance in which to create the table. Values are of the form +projects//instances/+.

Returns:

  • (String) —

    The unique name of the instance in which to create the table. Values are of the form +projects//instances/+.



50
51
52
53
54
55
56
 
# File 'lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/bigtable_table_admin.rb', line 50

class CreateTableRequest
  # An initial split point for a newly created table.
  # @!attribute [rw] key
  #   @return [String]
  #     Row key to use as an initial tablet boundary.
  class Split; end
end

#table ⇒ Google::Bigtable::Admin::V2::Table

Returns The Table to create.

Returns:



50
51
52
53
54
55
56
 
# File 'lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/bigtable_table_admin.rb', line 50

class CreateTableRequest
  # An initial split point for a newly created table.
  # @!attribute [rw] key
  #   @return [String]
  #     Row key to use as an initial tablet boundary.
  class Split; end
end

#table_id ⇒ String

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

Returns:

  • (String) —

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



50
51
52
53
54
55
56
 
# File 'lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/bigtable_table_admin.rb', line 50

class CreateTableRequest
  # An initial split point for a newly created table.
  # @!attribute [rw] key
  #   @return [String]
  #     Row key to use as an initial tablet boundary.
  class Split; end
end