Class Table (2.43.0)

Table(table_id, instance, mutation_timeout=None, app_profile_id=None)

Representation of a Google Cloud Bigtable Table.

  • create the table
  • delete the table
  • list_column_families in the table

Parameters

Name Description
table_id str

The ID of the table.

instance Instance

The instance that owns the table.

app_profile_id str

(Optional) The unique name of the AppProfile.

Properties

name

Table name used in requests.

For example:

.. literalinclude:: snippets_table.py :start-after: [START bigtable_api_table_name] :end-before: [END bigtable_api_table_name] :dedent: 4

"projects/../instances/../tables/{table_id}"

Returns
Type Description
str The table name.

Methods

append_row

append_row(row_key)

Create a xref_AppendRow associated with this table.

For example:

.. literalinclude:: snippets_table.py :start-after: [START bigtable_api_table_append_row] :end-before: [END bigtable_api_table_append_row] :dedent: 4

Parameter
Name Description
row_key bytes

The key for the row being created.

backup

backup(backup_id, cluster_id=None, expire_time=None)

Factory to create a Backup linked to this Table.

Parameters
Name Description
backup_id str

The ID of the Backup to be created.

cluster_id str

(Optional) The ID of the Cluster. Required for calling 'delete', 'exists' etc. methods.

expire_time datetime.datetime

(Optional) The expiration time of this new Backup. Required, if the create method needs to be called.

Returns
Type Description
.Backup A backup linked to this table.

column_family