package google.bigtable.admin.table.v1
Get desktop application:
View/edit binary Protocol Buffers messages
Service for creating, configuring, and deleting Cloud Bigtable tables. Provides access to the table schemas only, not the data stored within the tables.
Creates a new table, to be served from a specified cluster. The table can be created with a full set of initial column families, specified in the request.
string name = 1
The unique name of the cluster in which to create the new table.
string table_id = 2
The name by which the new table should be referred to within the cluster, e.g. "foobar" rather than "<cluster_name>/tables/foobar".
optional table = 3
The Table to create. The `name` field of the Table and all of its ColumnFamilies must be left blank, and will be populated in the response.
repeated string initial_split_keys = 4
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"}.
Lists the names of all tables served from a specified cluster.
string name = 1
The unique name of the cluster for which tables should be listed.
repeated tables = 1
The tables present in the requested cluster. At present, only the names of the tables are populated.
Gets the schema of the specified table, including its column families.
string name = 1
The unique name of the requested table.
Permanently deletes a specified table and all of its data.
string name = 1
The unique name of the table to be deleted.
Changes the name of a specified table. Cannot be used to move tables between clusters, zones, or projects.
string name = 1
The current unique name of the table.
string new_id = 2
The new name by which the table should be referred to within its containing cluster, e.g. "foobar" rather than "<cluster_name>/tables/foobar".
Creates a new column family within a specified table.
string name = 1
The unique name of the table in which to create the new column family.
string column_family_id = 2
The name by which the new column family should be referred to within the table, e.g. "foobar" rather than "<table_name>/columnFamilies/foobar".
optional column_family = 3
The column family to create. The `name` field must be left blank.
Changes the configuration of a specified column family.
Permanently deletes a specified column family and all of its data.
string name = 1
The unique name of the column family to be deleted.
Delete all rows in a table corresponding to a particular prefix
string table_name = 1
The unique name of the table on which to perform the bulk delete
oneof target
bytes row_key_prefix = 2
Delete all rows that start with this row key prefix. Prefix cannot be zero length.
bool delete_all_data_from_table = 3
Delete all rows in the table. Setting this to false is a no-op.
message
bigtable_table_data.proto:51A set of columns within a table which share a common configuration.
Used as request type in: BigtableTableService.UpdateColumnFamily
Used as response type in: BigtableTableService.CreateColumnFamily, BigtableTableService.UpdateColumnFamily
Used as field type in: ,
string name = 1
A unique identifier of the form <table_name>/columnFamilies/[-_.a-zA-Z0-9]+ The last segment is the same as the "name" field in google.bigtable.v1.Family.
string gc_expression = 2
Garbage collection expression specified by the following grammar: GC = EXPR | "" ; EXPR = EXPR, "||", EXPR (* lowest precedence *) | EXPR, "&&", EXPR | "(", EXPR, ")" (* highest precedence *) | PROP ; PROP = "version() >", NUM32 | "age() >", NUM64, [ UNIT ] ; NUM32 = non-zero-digit { digit } ; (* # NUM32 <= 2^32 - 1 *) NUM64 = non-zero-digit { digit } ; (* # NUM64 <= 2^63 - 1 *) UNIT = "d" | "h" | "m" (* d=days, h=hours, m=minutes, else micros *) GC expressions can be up to 500 characters in length The different types of PROP are defined as follows: version() - cell index, counting from most recent and starting at 1 age() - age of the cell (current time minus cell timestamp) Example: "version() > 3 || (age() > 3d && version() > 1)" drop cells beyond the most recent three, and drop cells older than three days unless they're the most recent cell in the row/column Garbage collection executes opportunistically in the background, and so it's possible for reads to return a cell even if it matches the active GC expression for its family.
optional gc_rule = 3
Garbage collection rule specified as a protobuf. Supersedes `gc_expression`. Must serialize to at most 500 bytes. NOTE: Garbage collection executes opportunistically in the background, and so it's possible for reads to return a cell even if it matches the active GC expression for its family.
message
bigtable_table_data.proto:95Rule for determining which cells to delete during garbage collection.
Used in: , ,
oneof rule
int32 max_num_versions = 1
Delete all cells in a column except the most recent N.
max_age = 2
Delete cells in a column older than the given age. Values must be at least one millisecond, and will be truncated to microsecond granularity.
intersection = 3
Delete cells that would be deleted by every nested rule.
union = 4
Delete cells that would be deleted by any nested rule.
message
bigtable_table_data.proto:97A GcRule which deletes cells matching all of the given rules.
Used in:
repeated rules = 1
Only delete cells which would be deleted by every element of `rules`.
message
bigtable_table_data.proto:103A GcRule which deletes cells matching any of the given rules.
Used in:
repeated rules = 1
Delete cells which would be deleted by any element of `rules`.
message
bigtable_table_data.proto:29A collection of user data indexed by row, column, and timestamp. Each table is served using the resources of its parent cluster.
Used as response type in: BigtableTableService.CreateTable, BigtableTableService.GetTable
Used as field type in: ,
string name = 1
A unique identifier of the form <cluster_name>/tables/[_a-zA-Z0-9][-_.a-zA-Z0-9]*
optional current_operation = 2
If this Table is in the process of being created, the Operation used to track its progress. As long as this operation is present, the Table will not accept any Table Admin or Read/Write requests.
map<string, > column_families = 3
The column families configured for this table, mapped by column family id.
Table.TimestampGranularity granularity = 4
The granularity (e.g. MILLIS, MICROS) at which timestamps are stored in this table. Timestamps not matching the granularity will be rejected. Cannot be changed once the table is created.
Used in:
MILLIS = 0