gcloud alpha bigtable tables describe Stay organized with collections Save and categorize content based on your preferences.
- NAME
- gcloud alpha bigtable tables describe - retrieve information about a table
- SYNOPSIS
gcloud alpha bigtable tables describe(TABLE:--instance=INSTANCE)[--view=VIEW; default="schema"][GCLOUD_WIDE_FLAG …]
- DESCRIPTION
(ALPHA)Retrieve information about a table.- EXAMPLES
- To describe a table, run:
gcloudalphabigtabletablesdescribeTABLE_NAME--instance=INSTANCE_NAME - POSITIONAL ARGUMENTS
- Table resource - Cloud Bigtable table to describe. The arguments in this groupcan be used to specify the attributes of this resource. (NOTE) Some attributesare 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 fullyspecified 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 thisgroup 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 fullyspecified name; - provide the argument
--instanceon the command line.
- provide the argument
- provide the argument
- Table resource - Cloud Bigtable table to describe. The arguments in this groupcan be used to specify the attributes of this resource. (NOTE) Some attributesare not given arguments in this group but can be set in other ways.
- FLAGS
--view=VIEW; default="schema"- The view to be applied to the returned table's fields.
VIEWmust be one of:encryption- Only populates
nameand fields related to the table's encryptionstatus. full- Populates all fields.
name- Only populates
name. replication- Only populates
nameand fields related to the table's replication. schema- Only populates
nameand fields related to the table's schema. stats- Only populates
nameand fields related to the table's statistics(e.g. TableStats and ColumnFamilyStats).
- 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 documentationfor this API can be found at:https://cloud.google.com/bigtable/ - NOTES
- This command is currently in alpha and might change without notice. If thiscommand fails with API permission errors despite specifying the correct project,you might be trying to access an API with an invitation-only early accessallowlist. These variants are also available:
gcloudbigtabletablesdescribegcloudbetabigtabletablesdescribe
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-15 UTC.