- NAME
-
- gcloud beta bigtable tables create - create a new Cloud Bigtable table
- SYNOPSIS
-
-
gcloud beta bigtable 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 table
my-tablein instancemy-instancewith a column familymy-family, run:gcloud beta bigtable tables create my-table --instance=my-instance --column-families="my-family"To create a table that has a column family named
my-instance, a garbage collection policy that lets data expire after 864,000 seconds, and initial table splits on row keyscarandkey, run:gcloud beta bigtable tables create my-table --instance=my-instance --column-families="my-family:maxage=864000s" --splits=car,keyTo create a table
my-tablein instancemy-instancethat lets data in column familymy-family1expire after 10 days and keeps a maximum of 5 cells per column in column familymy-family-2if the data is less than 5 days old, run:gcloud beta bigtable tables create my-table --instance=my-instance --column-families="my-family-1:maxage=10d,my-family-2:maxversions=5||maxage=5d"To create a table
my-tablethat has one column familymy-familythat lets data expire after 10 days, and to enable a change stream for the table to be kept for 7 days, run:gcloud beta bigtable tables create my-table --instance=my-instance --column-families="my-family:maxage=10d" --change-stream-retention-period=7dTo create a deletion-protected table
my-tablein instancemy-instancewith a column familymy-family, run:gcloud beta bigtable tables create my-table --instance=my-instance --column-families="my-family" --deletion-protectionTo create a table
my-tablewithout deletion protection in instancemy-instancewith a column familymy-family, run:gcloud beta bigtable tables create my-table --instance=my-instance --column-families="my-family" --no-deletion-protectionTo create a table
my-tablewith the default automated backup policy (retention_period=7d, frequency=1d) enabled in instancemy-instancewith a column familymy-family, run:gcloud beta bigtable tables create my-table --instance=my-instance --column-families="my-family" --enable-automated-backupTo create a table
my-tablewith a custom automated backup policy configured to retain backups for 30 days in instancemy-instancewith a column familymy-family, run:gcloud beta bigtable tables create my-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 can
be used to specify the attributes of this resource. (NOTE) Some attributes are
not given arguments in this group but can be set in other ways.
To set the
projectattribute:-
provide the argument
tableon the command line with a fully specified name; -
provide the argument
--projecton the command line; -
set the property
core/project.
This must be specified.
TABLE-
ID of the table or fully qualified identifier for the table.
To set the
tableattribute:-
provide the argument
tableon the command line.
This positional argument must be specified if any of the other arguments in this group are specified.
-
provide the argument
--instance=INSTANCE-
Name of the Bigtable instance.
To set the
instanceattribute:-
provide the argument
tableon the command line with a fully specified name; -
provide the argument
--instanceon the command line.
-
provide the argument
-
provide the argument
-
Table resource - Cloud Bigtable table to create. The arguments in this group can
be used to specify the attributes of this resource. (NOTE) Some attributes are
not given arguments in this group but can be set in other ways.
- REQUIRED FLAGS
-
--column-families=[COLUMN_FAMILIES,…]-
A double-quote (
") wrapped list of family name and corresponding garbage collection rules concatenated by:, where the rules are optional. 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), and
seconds (s). Passing in a value for this option enables a change stream for the
table. Examples:
5dor48h. --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: field1 type: bytesType: encoding: raw: {} - fieldName: field2 type: bytesType: encoding: raw: {}
--row-key-schema-pre-encoded-bytes-
By default, Base64 encoding is applied to all binary fields in the YAML/JSON
file (for example,
encoding.delimitedBytes.delimiter).Use this to indicate that all binary fields are already encoded in the YAML/JSON file 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 topic datetimesfor 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 of
30dfor 30 days. Min retention period is3dand 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 helpfor details. - API REFERENCE
-
This command uses the
bigtableadmin/v2API. The full documentation for this API can be found at: https://cloud.google.com/bigtable/ - NOTES
-
This command is currently in beta and might change without notice. These
variants are also available:
gcloud bigtable tables creategcloud alpha bigtable tables create
gcloud beta bigtable tables create
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-07-22 UTC.