.TH "GCLOUD_BIGTABLE_TABLES_CREATE" 1



.SH "NAME"
.HP
gcloud bigtable tables create \- create a new Cloud Bigtable table



.SH "SYNOPSIS"
.HP
\f5gcloud bigtable tables create\fR (\fITABLE\fR\ :\ \fB\-\-instance\fR=\fIINSTANCE\fR) \fB\-\-column\-families\fR=[\fICOLUMN_FAMILIES\fR,...] [\fB\-\-change\-stream\-retention\-period\fR=\fICHANGE_STREAM_RETENTION_PERIOD\fR] [\fB\-\-deletion\-protection\fR] [\fB\-\-row\-key\-schema\-definition\-file\fR=\fIROW_KEY_SCHEMA_DEFINITION_FILE\fR] [\fB\-\-row\-key\-schema\-pre\-encoded\-bytes\fR] [\fB\-\-splits\fR=[\fISPLITS\fR,...]] [\fB\-\-automated\-backup\-retention\-period\fR=\fIAUTOMATED_BACKUP_RETENTION_PERIOD\fR\ |\ \fB\-\-enable\-automated\-backup\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

Create a new Cloud Bigtable table.



.SH "EXAMPLES"

To create a table \f5my\-table\fR in instance \f5my\-instance\fR with a column
family \f5my\-family\fR, run:

.RS 2m
$ gcloud bigtable tables create my\-table \-\-instance=my\-instance \e
    \-\-column\-families="my\-family"
.RE

To create a table that has a column family named \f5my\-instance\fR, a garbage
collection policy that lets data expire after 864,000 seconds, and initial table
splits on row keys \f5car\fR and \f5key\fR, run:

.RS 2m
$ gcloud bigtable tables create my\-table \-\-instance=my\-instance \e
    \-\-column\-families="my\-family:maxage=864000s" \-\-splits=car,key
.RE

To create a table \f5my\-table\fR in instance \f5my\-instance\fR that lets data
in column family \f5my\-family1\fR expire after 10 days and keeps a maximum of 5
cells per column in column family \f5my\-family\-2\fR if the data is less than 5
days old, run:

.RS 2m
$ gcloud bigtable tables create my\-table \-\-instance=my\-instance \e
    \-\-column\-families="my\-family\-1:maxage=10d,my\-family\-2:maxversion\e
s=5||maxage=5d"
.RE

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

.RS 2m
$ gcloud bigtable tables create my\-table \-\-instance=my\-instance \e
    \-\-column\-families="my\-family:maxage=10d" \e
    \-\-change\-stream\-retention\-period=7d
.RE

To create a deletion\-protected table \f5my\-table\fR in instance
\f5my\-instance\fR with a column family \f5my\-family\fR, run:

.RS 2m
$ gcloud bigtable tables create my\-table \-\-instance=my\-instance \e
    \-\-column\-families="my\-family" \-\-deletion\-protection
.RE

To create a table \f5my\-table\fR without deletion protection in instance
\f5my\-instance\fR with a column family \f5my\-family\fR, run:

.RS 2m
$ gcloud bigtable tables create my\-table \-\-instance=my\-instance \e
    \-\-column\-families="my\-family" \-\-no\-deletion\-protection
.RE

To create a table \f5my\-table\fR with the default automated backup policy
(retention_period=7d, frequency=1d) enabled in instance \f5my\-instance\fR with
a column family \f5my\-family\fR, run:

.RS 2m
$ gcloud bigtable tables create my\-table \-\-instance=my\-instance \e
    \-\-column\-families="my\-family" \-\-enable\-automated\-backup
.RE

To create a table \f5my\-table\fR with a custom automated backup policy
configured to retain backups for 30 days in instance \f5my\-instance\fR with a
column family \f5my\-family\fR, run:

.RS 2m
$ gcloud bigtable tables create my\-table \-\-instance=my\-instance \e
    \-\-column\-families="my\-family" \e
    \-\-automated\-backup\-retention_period=30d
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

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 \f5project\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5table\fR on the command line with a fully specified
name;
.IP "\(em" 2m
provide the argument \f5\-\-project\fR on the command line;
.IP "\(em" 2m
set the property \f5core/project\fR.
.RE
.sp

This must be specified.


.RS 2m
.TP 2m
\fITABLE\fR

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

To set the \f5table\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5table\fR on the command line.
.RE
.sp

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

.TP 2m
\fB\-\-instance\fR=\fIINSTANCE\fR

Name of the Bigtable instance.

To set the \f5instance\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5table\fR on the command line with a fully specified
name;
.IP "\(bu" 2m
provide the argument \f5\-\-instance\fR on the command line.
.RE
.sp


.RE
.RE
.sp

.SH "REQUIRED FLAGS"

.RS 2m
.TP 2m
\fB\-\-column\-families\fR=[\fICOLUMN_FAMILIES\fR,...]

A double\-quote (\f5"\fR) wrapped list of family name and corresponding garbage
collection rules concatenated by \f5:\fR, where the rules are optional. For
example:
\f5"family_1,family_2:maxage=5d&&maxversions=2,family_3:maxage=10d||maxversions=5"\fR


.RE
.sp

.SH "OPTIONAL FLAGS"

.RS 2m
.TP 2m
\fB\-\-change\-stream\-retention\-period\fR=\fICHANGE_STREAM_RETENTION_PERIOD\fR

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: \f55d\fR or \f548h\fR.

.TP 2m
\fB\-\-deletion\-protection\fR

Once specified, the table is deletion protected.

.TP 2m
\fB\-\-row\-key\-schema\-definition\-file\fR=\fIROW_KEY_SCHEMA_DEFINITION_FILE\fR

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:

.RS 2m
encoding:
  delimitedBytes:
    delimiter: '#'
fields:
\- fieldName: field1
  type:
    bytesType:
      encoding:
        raw: {}
\- fieldName: field2
  type:
    bytesType:
      encoding:
        raw: {}
.RE

.TP 2m
\fB\-\-row\-key\-schema\-pre\-encoded\-bytes\fR

By default, Base64 encoding is applied to all binary fields in the YAML/JSON
file (for example, \f5encoding.delimitedBytes.delimiter\fR).

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

.TP 2m
\fB\-\-splits\fR=[\fISPLITS\fR,...]

Row keys where the table should initially be split. For example: \f5car,key\fR

.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-automated\-backup\-retention\-period\fR=\fIAUTOMATED_BACKUP_RETENTION_PERIOD\fR

The retention period of automated backup in the format of \f530d\fR for 30 days.
Min retention period is \f53d\fR and max is \f590d\fR. Setting this flag will
enable automated backup for the table.

.TP 2m
\fB\-\-enable\-automated\-backup\fR

Once set, enables the default automated backup policy (retention_period=7d,
frequency=1d) for the table.


.RE
.RE
.sp

.SH "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 \fB$ gcloud help\fR for details.



.SH "API REFERENCE"

This command uses the \fBbigtableadmin/v2\fR API. The full documentation for
this API can be found at: https://cloud.google.com/bigtable/



.SH "NOTES"

These variants are also available:

.RS 2m
$ gcloud alpha bigtable tables create
.RE

.RS 2m
$ gcloud beta bigtable tables create
.RE