- 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. - 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'
- 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.
To set the
dataset
attribute:-
provide the argument
dataset
on the command line.
-
provide the argument
-
provide the argument
-
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.
- 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": [ { "role": "ROLE", "[access type]": "ACCESS_VALUE" }, … ]}
Where
access type
is one of:domain
,userByEmail
,specialGroup
orview
.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: https://cloud.google.com/bigquery/docs/access-control
- 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. - API REFERENCE
-
This command uses the
bigquery/v2
API. The full documentation for this API can be found at: https://cloud.google.com/bigquery/ - NOTES
- 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.
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-02-06 UTC.