.TH "GCLOUD_BETA_BIGTABLE_TABLES_DESCRIBE" 1



.SH "NAME"
.HP
gcloud beta bigtable tables describe \- retrieve information about a table



.SH "SYNOPSIS"
.HP
\f5gcloud beta bigtable tables describe\fR (\fITABLE\fR\ :\ \fB\-\-instance\fR=\fIINSTANCE\fR) [\fB\-\-view\fR=\fIVIEW\fR;\ default="schema"] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

\fB(BETA)\fR Retrieve information about a table.



.SH "EXAMPLES"

To describe a table, run:

.RS 2m
$ gcloud beta bigtable tables describe TABLE_NAME \e
    \-\-instance=INSTANCE_NAME
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

Table resource \- Cloud Bigtable table to describe. 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 "FLAGS"

.RS 2m
.TP 2m
\fB\-\-view\fR=\fIVIEW\fR; default="schema"

The view to be applied to the returned table's fields. \fIVIEW\fR must be one
of:

.RS 2m
.TP 2m
\fBencryption\fR
Only populates \f5name\fR and fields related to the table's encryption status.
.TP 2m
\fBfull\fR
Populates all fields.
.TP 2m
\fBname\fR
Only populates \f5name\fR.
.TP 2m
\fBreplication\fR
Only populates \f5name\fR and fields related to the table's replication.
.TP 2m
\fBschema\fR
Only populates \f5name\fR and fields related to the table's schema.
.TP 2m
\fBstats\fR
Only populates \f5name\fR and fields related to the table's statistics (e.g.
TableStats and ColumnFamilyStats).
.RE
.sp



.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"

This command is currently in beta and might change without notice. These
variants are also available:

.RS 2m
$ gcloud bigtable tables describe
.RE

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