gcloud_alpha_bq_datasets_update (1)
NAME
- gcloud alpha bq datasets update - update a BigQuery dataset
SYNOPSIS
-
gcloud alpha bq datasets update DATASET [--description=DESCRIPTION] [--permissions-file=[PERMISSIONS_FILE,...]] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Update a BigQuery dataset.
POSITIONAL ARGUMENTS
-
-
- Dataset resource - The BigQuery dataset you want to update. This represents a Cloud 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 [dataset] 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.
-
- DATASET
-
ID of the dataset or fully qualified identifier for the dataset.
- Dataset resource - The BigQuery dataset you want to update. This represents a Cloud 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 [dataset] 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.
-
FLAGS
-
- --description=DESCRIPTION
-
Description of the dataset.
- --permissions-file=[PERMISSIONS_FILE,...]
-
A local yaml or JSON file containing the access permissions specifying who is
allowed to access the data.
YamlfFile should be specified the form:\ access:-
- ---
- role: ROLE [access type]: ACCESS_VALUE
- ---
-
-
and JSON file should be specified in the form: {"access": [.RS 2m
{
"role": "ROLE",
"[access type]": "ACCESS_VALUE"
},
... ]}
Where access type is one of: domain, userByEmail,
specialGroup or view.
If this field is not specified, BigQuery adds these default dataset access
permissions at creation time in :
-
- *
- specialGroup=projectReaders, role=READER
- *
- specialGroup=projectWriters, role=WRITER
- *
- specialGroup=projectOwners, role=OWNER
- *
-
userByEmail=[dataset creator email], role=OWNER
For more information on BigQuery permissions see:
cloud.google.com/bigquery/docs/access-control
GCLOUD WIDE FLAGS
These flags are available to all commands: --account, --configuration, --flags-file, --flatten, --format, --help, --log-http, --project, --quiet, --trace-token, --user-output-enabled, --verbosity. Run $ gcloud help for details.
API REFERENCE
This command uses the bigquery/v2 API. The full documentation for this API can be found at: cloud.google.com/bigquery
EXAMPLES
The following command updates the description on a dataset with ID my-dataset
-
$ gcloud alpha bq datasets update my-dataset \
--description 'My New Dataset Description'
NOTES
This command is currently in ALPHA and may change without notice. If this command fails with API permission errors despite specifying the right project, you will have to apply for early access and have your projects registered on the API whitelist to use it. To do so, contact Support at cloud.google.com/support