gcloud beta bigtable instances tables create

NAME
gcloud beta bigtable instances tables create - create a new Cloud Bigtable table
SYNOPSIS
gcloud beta bigtable instances tables create(TABLE :--instance=INSTANCE)--column-families=[COLUMN_FAMILIES,…][--change-stream-retention-period=CHANGE_STREAM_RETENTION_PERIOD][--deletion-protection][--row-key-schema-definition-file=ROW_KEY_SCHEMA_DEFINITION_FILE][--row-key-schema-pre-encoded-bytes][--splits=[SPLITS,…]][--tiered-storage-infrequent-access-older-than=TIERED_STORAGE_INFREQUENT_ACCESS_OLDER_THAN][--automated-backup-retention-period=AUTOMATED_BACKUP_RETENTION_PERIOD    |--enable-automated-backup][GCLOUD_WIDE_FLAG]
DESCRIPTION
(BETA) Create a new Cloud Bigtable table.
EXAMPLES
To create a tablemy-table in instancemy-instancewith a column familymy-family, run:
gcloudbetabigtableinstancestablescreatemy-table--instance=my-instance--column-families="my-family"

To create a table that has a column family namedmy-instance, agarbage collection policy that lets data expire after 864,000 seconds, andinitial table splits on row keyscar andkey, run:

gcloudbetabigtableinstancestablescreatemy-table--instance=my-instance--column-families="my-family:maxage=864000s"--splits=car,key

To create a tablemy-table in instancemy-instancethat lets data in column familymy-family1 expire after 10 days andkeeps a maximum of 5 cells per column in column familymy-family-2if the data is less than 5 days old, run:

gcloudbetabigtableinstancestablescreatemy-table--instance=my-instance--column-families="my-family-1:maxage=10d,my-family-2:maxversions=5||maxage=5d"

To create a tablemy-table that has one column familymy-family that lets data expire after 10 days, and to enable achange stream for the table to be kept for 7 days, run:

gcloudbetabigtableinstancestablescreatemy-table--instance=my-instance--column-families="my-family:maxage=10d"--change-stream-retention-period=7d

To create a deletion-protected tablemy-table in instancemy-instance with a column familymy-family, run:

gcloudbetabigtableinstancestablescreatemy-table--instance=my-instance--column-families="my-family"--deletion-protection

To create a tablemy-table without deletion protection in instancemy-instance with a column familymy-family, run:

gcloudbetabigtableinstancestablescreatemy-table--instance=my-instance--column-families="my-family"--no-deletion-protection

To create a tablemy-table with the default automated backup policy(retention_period=7d, frequency=1d) enabled in instancemy-instancewith a column familymy-family, run:

gcloudbetabigtableinstancestablescreatemy-table--instance=my-instance--column-families="my-family"--enable-automated-backup

To create a tablemy-table with a custom automated backup policyconfigured to retain backups for 30 days in instancemy-instancewith a column familymy-family, run:

gcloudbetabigtableinstancestablescreatemy-table--instance=my-instance--column-families="my-family"--automated-backup-retention_period=30d
POSITIONAL ARGUMENTS
Table resource - Cloud Bigtable table to create. The arguments in this group canbe used to specify the attributes of this resource. (NOTE) Some attributes arenot given arguments in this group but can be set in other ways.

To set theproject attribute:

  • provide the argumenttable on the command line with a fullyspecified name;
  • provide the argument--project on the command line;
  • set the propertycore/project.

This must be specified.

TABLE
ID of the table or fully qualified identifier for the table.

To set thetable attribute:

  • provide the argumenttable on the command line.

This positional argument must be specified if any of the other arguments in thisgroup are specified.

--instance=INSTANCE
Name of the Bigtable instance.

To set theinstance attribute:

  • provide the argumenttable on the command line with a fullyspecified name;
  • provide the argument--instance on the command line.
REQUIRED FLAGS
--column-families=[COLUMN_FAMILIES,…]
A double-quote (") wrapped list of family name and correspondinggarbage collection rules concatenated by:, where the rules areoptional. For example:"family_1,family_2:maxage=5d&&maxversions=2,family_3:maxage=10d||maxversions=5"
OPTIONAL FLAGS
--change-stream-retention-period=CHANGE_STREAM_RETENTION_PERIOD
The length of time to retain change stream data for the table, in the range of[1 day, 7 days]. Acceptable units are days (d), hours (h), minutes (m), andseconds (s). Passing in a value for this option enables a change stream for thetable. Examples:5d or48h.
--deletion-protection
Once specified, the table is deletion protected.
--row-key-schema-definition-file=ROW_KEY_SCHEMA_DEFINITION_FILE
The row key schema for the table. The schema is defined in a YAML or JSON file,equivalent to the StructType protobuf message.

Example YAML:

encoding:delimitedBytes:delimiter:'#'fields:-fieldName:field1type:bytesType:encoding:raw:{}-fieldName:field2type:bytesType:encoding:raw:{}
--row-key-schema-pre-encoded-bytes
By default, Base64 encoding is applied to all binary fields in the YAML/JSONfile (for example,encoding.delimitedBytes.delimiter).

Use this to indicate that all binary fields are already encoded in the YAML/JSONfile and should not be encoded again.

--splits=[SPLITS,…]
Row keys where the table should initially be split. For example:car,key
--tiered-storage-infrequent-access-older-than=TIERED_STORAGE_INFREQUENT_ACCESS_OLDER_THAN
The age at which data should be moved to infrequent access storage.

See$gcloud topicdatetimes for information on absolute duration formats.

At most one of these can be specified:
--automated-backup-retention-period=AUTOMATED_BACKUP_RETENTION_PERIOD
The retention period of automated backup in the format of30d for30 days. Min retention period is3d and max is90d.Setting this flag will enable automated backup for the table.
--enable-automated-backup
Once set, enables the default automated backup policy (retention_period=7d,frequency=1d) for the table.
GCLOUD WIDE FLAGS
These flags are available to all commands:--access-token-file,--account,--billing-project,--configuration,--flags-file,--flatten,--format,--help,--impersonate-service-account,--log-http,--project,--quiet,--trace-token,--user-output-enabled,--verbosity.

Run$gcloud help for details.

API REFERENCE
This command uses thebigtableadmin/v2 API. The full documentationfor this API can be found at:https://cloud.google.com/bigtable/
NOTES
This command is currently in beta and might change without notice. Thesevariants are also available:
gcloudbigtableinstancestablescreate
gcloudalphabigtableinstancestablescreate

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-07-22 UTC.