gcloud alpha bq datasets config export

NAME
gcloud alpha bq datasets config export - export the configuration for a Google BigQuery dataset
SYNOPSIS
gcloud alpha bq datasets config export([DATASET]]--all) [--path=PATH; default="-"] [--resource-format=RESOURCE_FORMAT] [GCLOUD_WIDE_FLAG]
DESCRIPTION
(ALPHA)gcloud alpha bq datasets config export exportsthe configuration for a Google BigQuery dataset.

Dataset 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 alldatasets within the project.

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

EXAMPLES
To export the configuration for a dataset, run:
gcloudalphabqdatasetsconfigexportmy-dataset

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

gcloudalphabqdatasetsconfigexportmy-dataset--path=/path/to/dir/

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

gcloudalphabqdatasetsconfigexportmy-dataset--resource-format=terraform

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

gcloudalphabqdatasetsconfigexport--all
POSITIONAL ARGUMENTS
Exactly one of these must be specified:
DATASET
ID of the dataset or fully qualified identifier for the dataset.

To set thedataset attribute:

  • provide the argumentdataset 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.