gcloud_alpha_bq_tables_update (1)
NAME
- gcloud alpha bq tables update - update a new BigQuery table
SYNOPSIS
-
gcloud alpha bq tables update (TABLE : --dataset=DATASET) [--description=DESCRIPTION] [--expiration=EXPIRATION] [--relax-columns=[FIELD_NAME,...]] [--add-columns=FIELD_NAME=FIELD_TYPE | --add-columns-file=ADD_COLUMNS_FILE] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Create a new BigQuery table. Updates one or more attributes of a
POSITIONAL ARGUMENTS
-
-
Table resource - The BigQuery table you want to update. The arguments in this
group can be used to specify the attributes of this 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 [table] 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.
-
- TABLE
-
ID of the table or fully qualified identifier for the table. This positional
must be specified if any of the other arguments in this group are specified.
- --dataset=DATASET
-
The id of the BigQuery dataset.
-
-
Table resource - The BigQuery table you want to update. The arguments in this
group can be used to specify the attributes of this 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 [table] 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 table.
- --expiration=EXPIRATION
-
How long after creation should this table or view expire e.g. 1d, 2w etc.
See $ gcloud topic datetimes for information on duration formats
- --relax-columns=[FIELD_NAME,...]
-
A comma-separated list of field names in the current schema that should have
their mode changed from REQUIRED to NULLABLE.
For more details on updating and managing BigQuery schemas see: cloud.google.com/bigquery/docs/managing-table-schemas
-
Specify changes to the table schema. At most one of these may be specified:
-
- --add-columns=FIELD_NAME=FIELD_TYPE
-
A comma-separated list of entries of the form FIELD_NAME[=FIELD_TYPE]
specifying field names and types for the columns being added to the table.
FIELD_TYPE defaults to string if not present. Possible FIELD_TYPES are
string, integer, float, boolean, record, and
timestamp.
For more details on BigQuery schemas see: cloud.google.com/bigquery/docs/schemas
- --add-columns-file=ADD_COLUMNS_FILE
-
The name of a JSON file containing a single object containing an array each
element of which is an object with properties name, type, and, optionally a mode
(one of: NULLABLE or REPEATED), specifying the columns to be added
to the table. If mode is omitted the default is 'NULLABLE'.
For example: { 'schema': [ { 'name': 'field1', 'type': 'string', 'mode': 'REQUIRED' }, { 'name': 'field2', 'type': 'integer', 'mode': 'REPEATED' }, [ { 'name': 'fieldN', 'type': TYPE, ['mode': MODE] } ... ] ] }
For more details on BigQuery schemas see: cloud.google.com/bigquery/docs/schemas
-
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 table with ID my-table in my-dataset:
-
$ gcloud alpha bq tables update \
/projects/myproject/datasets/my-dataset/tables/my-table \
--description 'My New Table'
The following command changes the schema mode from REQUIRED to NULLABLE on the value and tags columns in a table with ID my-other-table in dataset my-other-dataset:
-
$ gcloud alpha bq tables update my-other-table \
--dataset my-other-dataset \
--relax-columns name,tags
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