- 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:
gcloud alpha bigtable tables describe TABLE_NAME --instance=INSTANCE_NAME
- POSITIONAL ARGUMENTS
-
-
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
project
attribute:-
provide the argument
table
on the command line with a fully specified name; -
provide the argument
--project
on 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
table
attribute:-
provide the argument
table
on 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 Cloud Bigtable instance.
To set the
instance
attribute:-
provide the argument
table
on the command line with a fully specified name; -
provide the argument
--instance
on the command line.
-
provide the argument
-
provide the argument
-
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.
- FLAGS
-
--view
=VIEW
; default="schema"-
The view to be applied to the returned table's fields.
VIEW
must be one of:encryption
-
Only populates
name
and fields related to the table's encryption status. full
- Populates all fields.
name
-
Only populates
name
. replication
-
Only populates
name
and fields related to the table's replication. schema
-
Only populates
name
and fields related to the table's schema. stats
-
Only populates
name
and 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 help
for details. - API REFERENCE
-
This command uses the
bigtableadmin/v2
API. The full documentation for this API can be found at: https://cloud.google.com/bigtable/ - NOTES
-
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct project,
you might be trying to access an API with an invitation-only early access
allowlist. These variants are also available:
gcloud bigtable tables describe
gcloud beta bigtable tables describe
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 2024-03-05 UTC.