Struct Table 

#[non_exhaustive]
pub struct Table {
    pub name: String,
    pub cluster_states: HashMap<String, ClusterState>,
    pub column_families: HashMap<String, ColumnFamily>,
    pub granularity: TimestampGranularity,
    pub restore_info: Option<RestoreInfo>,
    pub change_stream_config: Option<ChangeStreamConfig>,
    pub deletion_protection: bool,
    pub row_key_schema: Option<Struct>,
    pub automated_backup_config: Option<AutomatedBackupConfig>,
    /* private fields */
}

A collection of user data indexed by row, column, and timestamp. Each table is served using the resources of its parent cluster.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

The unique name of the table. Values are of the form projects/{project}/instances/{instance}/tables/[_a-zA-Z0-9][-_.a-zA-Z0-9]*. Views: NAME_ONLY, SCHEMA_VIEW, REPLICATION_VIEW, FULL

cluster_states: HashMap<String, ClusterState>

Output only. Map from cluster ID to per-cluster table state. If it could not be determined whether or not the table has data in a particular cluster (for example, if its zone is unavailable), then there will be an entry for the cluster with UNKNOWN replication_status. Views: REPLICATION_VIEW, ENCRYPTION_VIEW, FULL

column_families: HashMap<String, ColumnFamily>

The column families configured for this table, mapped by column family ID. Views: SCHEMA_VIEW, STATS_VIEW, FULL

granularity: TimestampGranularity

Immutable. The granularity (i.e. MILLIS) at which timestamps are stored in this table. Timestamps not matching the granularity will be rejected. If unspecified at creation time, the value will be set to MILLIS. Views: SCHEMA_VIEW, FULL.

restore_info: Option<RestoreInfo>

Output only. If this table was restored from another data source (e.g. a backup), this field will be populated with information about the restore.

change_stream_config: Option<ChangeStreamConfig>

If specified, enable the change stream on this table. Otherwise, the change stream is disabled and the change stream is not retained.

deletion_protection: bool

Set to true to make the table protected against data loss. i.e. deleting the following resources through Admin APIs are prohibited:

• The table.
• The column families in the table.
• The instance containing the table.

Note one can still delete the data stored in the table through Data APIs.

row_key_schema: Option<Struct>

The row key schema for this table. The schema is used to decode the raw row key bytes into a structured format. The order of field declarations in this schema is important, as it reflects how the raw row key bytes are structured. Currently, this only affects how the key is read via a GoogleSQL query from the ExecuteQuery API.

For a SQL query, the _key column is still read as raw bytes. But queries can reference the key fields by name, which will be decoded from _key using provided type and encoding. Queries that reference key fields will fail if they encounter an invalid row key.

For example, if _key = “some_id#2024-04-30#\x00\x13\x00\xf3” with the following schema: { fields { field_name: “id” type { string { encoding: utf8_bytes {} } } } fields { field_name: “date” type { string { encoding: utf8_bytes {} } } } fields { field_name: “product_code” type { int64 { encoding: big_endian_bytes {} } } } encoding { delimited_bytes { delimiter: “#” } } }

The decoded key parts would be: id = “some_id”, date = “2024-04-30”, product_code = 1245427 The query “SELECT _key, product_code FROM table” will return two columns: /——————————————————\

_key	product_code
“some_id#2024-04-30#\x00\x13\x00\xf3”	1245427
-—————————————————–/

The schema has the following invariants: (1) The decoded field values are order-preserved. For read, the field values will be decoded in sorted mode from the raw bytes. (2) Every field in the schema must specify a non-empty name. (3) Every field must specify a type with an associated encoding. The type is limited to scalar types only: Array, Map, Aggregate, and Struct are not allowed. (4) The field names must not collide with existing column family names and reserved keywords “_key” and “_timestamp”.

The following update operations are allowed for row_key_schema:

• Update from an empty schema to a new schema.
• Remove the existing schema. This operation requires setting the ignore_warnings flag to true, since it might be a backward incompatible change. Without the flag, the update request will fail with an INVALID_ARGUMENT error. Any other row key schema update operation (e.g. update existing schema columns names or types) is currently unsupported.

automated_backup_config: Option<AutomatedBackupConfig>

Implementations

impl Table

pub fn new() -> Self

pub fn set_name<T: Into<String>>(self, v: T) -> Self

Sets the value of name.

Example

let x = Table::new().set_name("example");

pub fn set_cluster_states<T, K, V>(self, v: T) -> Self

where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<ClusterState>,

Sets the value of cluster_states.

Example

use google_cloud_bigtable_admin_v2::model::table::ClusterState;
let x = Table::new().set_cluster_states([
    ("key0", ClusterState::default()/* use setters */),
    ("key1", ClusterState::default()/* use (different) setters */),
]);

pub fn set_column_families<T, K, V>(self, v: T) -> Self

where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<ColumnFamily>,

Sets the value of column_families.

Example

use google_cloud_bigtable_admin_v2::model::ColumnFamily;
let x = Table::new().set_column_families([
    ("key0", ColumnFamily::default()/* use setters */),
    ("key1", ColumnFamily::default()/* use (different) setters */),
]);

pub fn set_granularity<T: Into<TimestampGranularity>>(self, v: T) -> Self

Sets the value of granularity.

Example

use google_cloud_bigtable_admin_v2::model::table::TimestampGranularity;
let x0 = Table::new().set_granularity(TimestampGranularity::Millis);

pub fn set_restore_info<T>(self, v: T) -> Self

where T: Into<RestoreInfo>,

Sets the value of restore_info.

Example

use google_cloud_bigtable_admin_v2::model::RestoreInfo;
let x = Table::new().set_restore_info(RestoreInfo::default()/* use setters */);

pub fn set_or_clear_restore_info<T>(self, v: Option<T>) -> Self

where T: Into<RestoreInfo>,

Sets or clears the value of restore_info.

Example

use google_cloud_bigtable_admin_v2::model::RestoreInfo;
let x = Table::new().set_or_clear_restore_info(Some(RestoreInfo::default()/* use setters */));
let x = Table::new().set_or_clear_restore_info(None::<RestoreInfo>);

pub fn set_change_stream_config<T>(self, v: T) -> Self

where T: Into<ChangeStreamConfig>,

Sets the value of change_stream_config.

Example

use google_cloud_bigtable_admin_v2::model::ChangeStreamConfig;
let x = Table::new().set_change_stream_config(ChangeStreamConfig::default()/* use setters */);

pub fn set_or_clear_change_stream_config<T>(self, v: Option<T>) -> Self

where T: Into<ChangeStreamConfig>,

Sets or clears the value of change_stream_config.

Example

use google_cloud_bigtable_admin_v2::model::ChangeStreamConfig;
let x = Table::new().set_or_clear_change_stream_config(Some(ChangeStreamConfig::default()/* use setters */));
let x = Table::new().set_or_clear_change_stream_config(None::<ChangeStreamConfig>);

pub fn set_deletion_protection<T: Into<bool>>(self, v: T) -> Self

Sets the value of deletion_protection.

Example

let x = Table::new().set_deletion_protection(true);

pub fn set_row_key_schema<T>(self, v: T) -> Self

where T: Into<Struct>,

Sets the value of row_key_schema.

Example

use google_cloud_bigtable_admin_v2::model::r#type::Struct;
let x = Table::new().set_row_key_schema(Struct::default()/* use setters */);

pub fn set_or_clear_row_key_schema<T>(self, v: Option<T>) -> Self

where T: Into<Struct>,

Sets or clears the value of row_key_schema.

Example

use google_cloud_bigtable_admin_v2::model::r#type::Struct;
let x = Table::new().set_or_clear_row_key_schema(Some(Struct::default()/* use setters */));
let x = Table::new().set_or_clear_row_key_schema(None::<Struct>);

pub fn set_automated_backup_config<T: Into<Option<AutomatedBackupConfig>>>( self, v: T, ) -> Self

Sets the value of automated_backup_config.

Note that all the setters affecting automated_backup_config are mutually exclusive.

Example

use google_cloud_bigtable_admin_v2::model::table::AutomatedBackupPolicy;
let x = Table::new().set_automated_backup_config(Some(
    google_cloud_bigtable_admin_v2::model::table::AutomatedBackupConfig::AutomatedBackupPolicy(AutomatedBackupPolicy::default().into())));

pub fn automated_backup_policy(&self) -> Option<&Box<AutomatedBackupPolicy>>

The value of automated_backup_config if it holds a AutomatedBackupPolicy, None if the field is not set or holds a different branch.

pub fn set_automated_backup_policy<T: Into<Box<AutomatedBackupPolicy>>>( self, v: T, ) -> Self

Sets the value of automated_backup_config to hold a AutomatedBackupPolicy.

Note that all the setters affecting automated_backup_config are mutually exclusive.

Example

use google_cloud_bigtable_admin_v2::model::table::AutomatedBackupPolicy;
let x = Table::new().set_automated_backup_policy(AutomatedBackupPolicy::default()/* use setters */);
assert!(x.automated_backup_policy().is_some());

Trait Implementations

impl Clone for Table

fn clone(&self) -> Table

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Table

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Table

fn default() -> Table

Returns the “default value” for a type.

impl Message for Table

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Table

fn eq(&self, other: &Table) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Table