tables

Creates, updates, deletes, gets or lists a tables resource.

Overview

Name	tables
Type	Resource
Id	google.bigtableadmin.tables

Fields

Name	Datatype	Description
name	string	The unique name of the table. Values are of the form projects/{project}/instances/{instance}/tables/_a-zA-Z0-9*. Views: NAME_ONLY, SCHEMA_VIEW, REPLICATION_VIEW, STATS_VIEW, FULL
automatedBackupPolicy	object	Defines an automated backup policy for a table
changeStreamConfig	object	Change stream configuration.
clusterStates	object	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
columnFamilies	object	The column families configured for this table, mapped by column family ID. Views: SCHEMA_VIEW, STATS_VIEW, FULL
deletionProtection	boolean	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.
granularity	string	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.
restoreInfo	object	Information about a table restore.
stats	object	Approximate statistics related to a table. These statistics are calculated infrequently, while simultaneously, data in the table can change rapidly. Thus the values reported here (e.g. row count) are very likely out-of date, even the instant they are received in this API. Thus, only treat these values as approximate. IMPORTANT: Everything below is approximate, unless otherwise specified.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	instancesId, projectsId, tablesId	Gets metadata information about the specified table.
list	SELECT	instancesId, projectsId	Lists all tables served from a specified instance.
create	INSERT	instancesId, projectsId	Creates a new table in the specified instance. The table can be created with a full set of initial column families, specified in the request.
delete	DELETE	instancesId, projectsId, tablesId	Permanently deletes a specified table and all of its data.
patch	UPDATE	instancesId, projectsId, tablesId	Updates a specified table.
check_consistency	EXEC	instancesId, projectsId, tablesId	Checks replication consistency based on a consistency token, that is, if replication has caught up based on the conditions specified in the token and the check request.
drop_row_range	EXEC	instancesId, projectsId, tablesId	Permanently drop/delete a row range from a specified table. The request can specify whether to delete all rows in a table, or only those that match a particular prefix. Note that row key prefixes used here are treated as service data. For more information about how service data is handled, see the Google Cloud Privacy Notice.
generate_consistency_token	EXEC	instancesId, projectsId, tablesId	Generates a consistency token for a Table, which can be used in CheckConsistency to check whether mutations to the table that finished before this call started have been replicated. The tokens will be available for 90 days.
modify_column_families	EXEC	instancesId, projectsId, tablesId	Performs a series of column family modifications on the specified table. Either all or none of the modifications will occur before this method returns, but data requests received prior to that point may see a table where only some modifications have taken effect.
restore	EXEC	instancesId, projectsId	Create a new table by restoring from a completed backup. The returned table long-running operation can be used to track the progress of the operation, and to cancel it. The metadata field type is RestoreTableMetadata. The response type is Table, if successful.
undelete	EXEC	instancesId, projectsId, tablesId	Restores a specified table which was accidentally deleted.

SELECT examples

Lists all tables served from a specified instance.

SELECT
name,
automatedBackupPolicy,
changeStreamConfig,
clusterStates,
columnFamilies,
deletionProtection,
granularity,
restoreInfo,
stats
FROM google.bigtableadmin.tables
WHERE instancesId = '{{ instancesId }}'
AND projectsId = '{{ projectsId }}';

INSERT example

Use the following StackQL query and manifest file to create a new tables resource.

All Properties

/*+ create */
INSERT INTO google.bigtableadmin.tables (
instancesId,
projectsId,
tableId,
table,
initialSplits
)
SELECT 
'{{ instancesId }}',
'{{ projectsId }}',
'{{ tableId }}',
'{{ table }}',
'{{ initialSplits }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: tableId
      value: string
    - name: table
      value:
        - name: name
          value: string
        - name: clusterStates
          value: object
        - name: columnFamilies
          value: object
        - name: granularity
          value: string
        - name: restoreInfo
          value:
            - name: sourceType
              value: string
            - name: backupInfo
              value:
                - name: backup
                  value: string
                - name: startTime
                  value: string
                - name: endTime
                  value: string
                - name: sourceTable
                  value: string
                - name: sourceBackup
                  value: string
        - name: changeStreamConfig
          value:
            - name: retentionPeriod
              value: string
        - name: deletionProtection
          value: boolean
        - name: stats
          value:
            - name: rowCount
              value: string
            - name: averageColumnsPerRow
              value: number
            - name: averageCellsPerColumn
              value: number
            - name: logicalDataBytes
              value: string
        - name: automatedBackupPolicy
          value:
            - name: retentionPeriod
              value: string
            - name: frequency
              value: string
    - name: initialSplits
      value:
        - - name: key
            value: string

UPDATE example

Updates a tables resource.

/*+ update */
UPDATE google.bigtableadmin.tables
SET 
name = '{{ name }}',
columnFamilies = '{{ columnFamilies }}',
granularity = '{{ granularity }}',
changeStreamConfig = '{{ changeStreamConfig }}',
deletionProtection = true|false,
automatedBackupPolicy = '{{ automatedBackupPolicy }}'
WHERE 
instancesId = '{{ instancesId }}'
AND projectsId = '{{ projectsId }}'
AND tablesId = '{{ tablesId }}';

DELETE example

Deletes the specified tables resource.

/*+ delete */
DELETE FROM google.bigtableadmin.tables
WHERE instancesId = '{{ instancesId }}'
AND projectsId = '{{ projectsId }}'
AND tablesId = '{{ tablesId }}';