42 lines
1.5 KiB
YAML
42 lines
1.5 KiB
YAML
- release_tracks: [GA, BETA, ALPHA]
|
|
|
|
help_text:
|
|
brief: Retrieve information about a table.
|
|
description: Retrieve information about a table.
|
|
examples: |
|
|
To describe a table, run:
|
|
|
|
$ {command} TABLE_NAME --instance=INSTANCE_NAME
|
|
|
|
request:
|
|
collection: bigtableadmin.projects.instances.tables
|
|
|
|
arguments:
|
|
resource:
|
|
help_text: Cloud Bigtable table to describe.
|
|
spec: !REF googlecloudsdk.command_lib.bigtable.resources:table
|
|
params:
|
|
- api_field: view
|
|
arg_name: view
|
|
help_text: The view to be applied to the returned table's fields.
|
|
default: schema
|
|
choices: # Enum is mapped to keep VIEW_UNSPECIFIED invisible from user.
|
|
- arg_value: name
|
|
enum_value: NAME_ONLY
|
|
help_text: Only populates `name`.
|
|
- arg_value: schema
|
|
enum_value: SCHEMA_VIEW
|
|
help_text: Only populates `name` and fields related to the table's schema.
|
|
- arg_value: replication
|
|
enum_value: REPLICATION_VIEW
|
|
help_text: Only populates `name` and fields related to the table's replication.
|
|
- arg_value: encryption
|
|
enum_value: ENCRYPTION_VIEW
|
|
help_text: Only populates `name` and fields related to the table's encryption status.
|
|
- arg_value: stats
|
|
enum_value: STATS_VIEW
|
|
help_text: Only populates `name` and fields related to the table's statistics (e.g. TableStats and ColumnFamilyStats).
|
|
- arg_value: full
|
|
enum_value: FULL
|
|
help_text: Populates all fields.
|