gcloud alpha sql databases config export

NAME
gcloud alpha sql databases config export - export the configuration for a Sqladmin database
SYNOPSIS
gcloud alpha sql databases config export([DATABASE :--instance=INSTANCE]--all)[--path=PATH; default="-"][--resource-format=RESOURCE_FORMAT][GCLOUD_WIDE_FLAG]
DESCRIPTION
(ALPHA)gcloud alpha sql databases config exportexports the configuration for a Sqladmin database.

Database configurations can be exported in Kubernetes Resource Model (krm) orTerraform HCL formats. The default format iskrm.

Specifying--all allows you to export the configurations for alldatabases within the project.

Specifying--path allows you to export the configuration(s) to alocal directory.

EXAMPLES
To export the configuration for a database, run:
gcloudalphasqldatabasesconfigexportmy-database

To export the configuration for a database to a file, run:

gcloudalphasqldatabasesconfigexportmy-database--path=/path/to/dir/

To export the configuration for a database in Terraform HCL format, run:

gcloudalphasqldatabasesconfigexportmy-database--resource-format=terraform

To export the configurations for all databases within a project, run:

gcloudalphasqldatabasesconfigexport--all
POSITIONAL ARGUMENTS
Exactly one of these must be specified:
Database resource - Database to export the configuration for. The arguments inthis group can be used to specify the attributes of this resource. (NOTE) Someattributes are not given arguments in this group but can be set in other ways.

To set theproject attribute:

  • provide the argumentdatabase on the command line with a fullyspecified name;
  • provide the argument--project on the command line;
  • set the propertycore/project.
DATABASE
ID of the database or fully qualified identifier for the database.

To set thedatabase attribute:

  • provide the argumentdatabase on the command line.

This positional argument must be specified if any of the other arguments in thisgroup are specified.

--instance=INSTANCE
The instance name.

To set theinstance attribute:

  • provide the argumentdatabase on the command line with a fullyspecified name;
  • provide the argument--instance on the command line.
--all
Retrieve all resources within the project. If--path is specifiedand is a valid directory, resources will be output as individual files based onresource name and scope. If--path is not specified, resources willbe streamed to stdout.
FLAGS
--path=PATH; default="-"
Path of the directory or file to output configuration(s). To outputconfigurations to stdout, specify "--path=-".
--resource-format=RESOURCE_FORMAT
Format of the configuration to export. Available configuration formats areKubernetes Resource Model YAML (krm) or Terraform HCL (terraform). Commanddefaults to "krm".RESOURCE_FORMAT must be one of:krm,terraform.
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 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.

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-05-07 UTC.