gcloud alpha spanner databases ddl describe Stay organized with collections Save and categorize content based on your preferences.
- NAME
- gcloud alpha spanner databases ddl describe - describe the DDL for a Cloud Spanner database
- SYNOPSIS
gcloud alpha spanner databases ddl describe(DATABASE:--instance=INSTANCE)[--include-proto-descriptors][--filter=EXPRESSION][--limit=LIMIT][--page-size=PAGE_SIZE][--sort-by=[FIELD,…]][--uri][GCLOUD_WIDE_FLAG …]
- DESCRIPTION
(ALPHA)Describe the DDL for a Cloud Spanner database.- EXAMPLES
- To describe the DDL for a given Cloud Spanner database, run:
gcloudalphaspannerdatabasesddldescribemy-database-id--instance=my-instance-id - POSITIONAL ARGUMENTS
- Database resource - The Cloud Spanner database of which the ddl to describe. Thearguments 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 inother ways.
To set the
projectattribute:- provide the argument
databaseon the command line with a fullyspecified name; - provide the argument
--projecton the command line; - set the property
core/project.
This must be specified.
DATABASE- ID of the database or fully qualified identifier for the database.
To set the
databaseattribute:- provide the argument
databaseon the command line.
This positional argument must be specified if any of the other arguments in thisgroup are specified.
- provide the argument
--instance=INSTANCE- The Cloud Spanner instance for the database.
To set the
instanceattribute:- provide the argument
databaseon the command line with a fullyspecified name; - provide the argument
--instanceon the command line; - set the property
spanner/instance.
- provide the argument
- provide the argument
- Database resource - The Cloud Spanner database of which the ddl to describe. Thearguments 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 inother ways.
- FLAGS
--include-proto-descriptors- Include debug string of proto bundle descriptors in the output. The output isinformation only and not meant to be parsed.
- LIST COMMAND FLAGS
--filter=EXPRESSION- Apply a Boolean filter
EXPRESSIONto each resource itemto be listed. If the expression evaluatesTrue, then that item islisted. For more details and examples of filter expressions, run $gcloud topic filters. This flaginteracts with other flags that are applied in this order:--flatten,--sort-by,--filter,--limit. --limit=LIMIT- Maximum number of resources to list. The default is
unlimited. Thisflag interacts with other flags that are applied in this order:--flatten,--sort-by,--filter,--limit. --page-size=PAGE_SIZE- Some services group resource list output into pages. This flag specifies themaximum number of resources per page. The default is determined by the serviceif it supports paging, otherwise it is
unlimited(no paging).Paging may be applied before or after--filterand--limitdepending on the service. --sort-by=[FIELD,…]- Comma-separated list of resource field key names to sort by. The default orderis ascending. Prefix a field with ``~´´ for descending order on thatfield. This flag interacts with other flags that are applied in this order:
--flatten,--sort-by,--filter,--limit. --uri- Print a list of resource URIs instead of the default output, and change thecommand output to a list of URIs. If this flag is used with
--format, the formatting is applied on this URI list. To displayURIs alongside other keys instead, use theuri()transform.
- 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. - 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:
gcloudspannerdatabasesddldescribegcloudbetaspannerdatabasesddldescribe
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 2026-02-18 UTC.