gcloud alpha bq datasets config export - export the configuration for a Google BigQuery dataset
gcloud alpha bq datasets config export (DATASET : --all) [--path=PATH; default="-"] [--resource-format=RESOURCE_FORMAT] [GCLOUD_WIDE_FLAG ...]
(ALPHA) gcloud alpha bq datasets config export exports the configuration for a Google BigQuery dataset.
Dataset configurations can be exported in Kubernetes Resource Model (krm) or Terraform HCL formats. The default format is krm.
Specifying --all allows you to export the configurations for all datasets within the project.
Specifying --path allows you to export the configuration(s) to a local directory.
To export the configuration for a dataset, run:
$ gcloud alpha bq datasets config export my-dataset
To export the configuration for a dataset to a file, run:
$ gcloud alpha bq datasets config export my-dataset \ --path=/path/to/dir/
To export the configuration for a dataset in Terraform HCL format, run:
$ gcloud alpha bq datasets config export my-dataset \ --resource-format=terraform
To export the configurations for all datasets within a project, run:
$ gcloud alpha bq datasets config export --all
- Exactly one of these must be specified:
- DATASET
ID of the dataset or fully qualified identifier for the dataset. To set the dataset attribute:
provide the argument dataset on the command line.
This positional argument must be specified if any of the other arguments in this group are specified.
- --all
Retrieve all resources within the project. If --path is specified and is a valid directory, resources will be output as individual files based on resource name and scope. If --path is not specified, resources will be streamed to stdout.
- --path=PATH; default="-"
Path of the directory or file to output configuration(s). To output configurations to stdout, specify "--path=-".
- --resource-format=RESOURCE_FORMAT
Format of the configuration to export. Available configuration formats are Kubernetes Resource Model YAML (krm) or Terraform HCL (terraform). Command defaults to "krm". RESOURCE_FORMAT must be one of: krm, terraform.
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.
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.