- NAME
-
- gcloud beta spanner databases ddl describe - describe the DDL for a Cloud Spanner database
- SYNOPSIS
-
-
gcloud beta 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
-
(BETA)
Describe the DDL for a Cloud Spanner database. - EXAMPLES
-
To describe the DDL for a given Cloud Spanner database, run:
gcloud beta spanner databases ddl describe my-database-id --instance=my-instance-id
- POSITIONAL ARGUMENTS
-
-
Database resource - The Cloud Spanner database of which the ddl 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
database
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.
DATABASE
-
ID of the database or fully qualified identifier for the database.
To set the
database
attribute:-
provide the argument
database
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
-
The Cloud Spanner instance for the database.
To set the
instance
attribute:-
provide the argument
database
on the command line with a fully specified name; -
provide the argument
--instance
on 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. 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
-
--include-proto-descriptors
- Include debug string of proto bundle descriptors in the output. The output is information only and not meant to be parsed.
- LIST COMMAND FLAGS
-
--filter
=EXPRESSION
-
Apply a Boolean filter
EXPRESSION
to each resource item to be listed. If the expression evaluatesTrue
, then that item is listed. For more details and examples of filter expressions, run $ gcloud topic filters. This flag interacts 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
. This flag 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 the
maximum number of resources per page. The default is determined by the service
if it supports paging, otherwise it is
unlimited
(no paging). Paging may be applied before or after--filter
and--limit
depending on the service. --sort-by
=[FIELD
,…]-
Comma-separated list of resource field key names to sort by. The default order
is ascending. Prefix a field with ``~´´ for descending order on that
field. 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 the
command output to a list of URIs. If this flag is used with
--format
, the formatting is applied on this URI list. To display URIs 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 help
for details. - NOTES
-
This command is currently in beta and might change without notice. These
variants are also available:
gcloud spanner databases ddl describe
gcloud alpha spanner databases ddl 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-06-11 UTC.