Console

1. In the Google Cloud console, select the dataset.

2. On the dataset details page, click the pencil icon to the right ofLabels.

   

3. In theEdit labels dialog:

   • To apply additional labels, clickAdd label. Each key can be usedonly once per dataset, but you can use the same key in differentdatasets in the same project.
   • Modify the existing keys or values to update a label.
   • ClickUpdate to save your changes.

SQL

Use theALTER SCHEMA SET OPTIONS DDL statementto set the labels on an existing dataset. Setting labels overwrites anyexisting labels on the dataset. The following example sets a single label onthe datasetmydataset:

1. In the Google Cloud console, go to theBigQuery page.

   Go to BigQuery

2. In the query editor, enter the following statement:

   ALTERSCHEMAmydatasetSETOPTIONS(labels=[('sensitivity','high')]);

3. Clickplay_circleRun.

For more information about how to run queries, seeRun an interactive query.

bq

To add additional labels or to update a dataset label, issue thebq updatecommand with theset_label flag. Repeat the flag to add or update multiplelabels.

If the dataset is in a project other than your default project, add theproject ID to the dataset in the following format:[PROJECT_ID]:[DATASET].

bqupdate\--set_labelkey:value\project_id:dataset

Where:

• key:value corresponds to a key:value pair for a label thatyou want to add or update. If you specify the same key as an existinglabel, the value for the existing label is updated. The key must be unique.
• project_id is your project ID.
• dataset is the dataset you're updating.

Example:

To update thedepartment label onmydataset, enter thebq updatecommand and specifydepartment as the label key. For example, to updatethedepartment:shipping label todepartment:logistics, enter thefollowing command.mydataset is inmyotherproject, not your defaultproject.

    bq update \    --set_label department:logistics \    myotherproject:mydataset

The output looks like the following.

Dataset 'myotherproject:mydataset' successfully updated.

API

To add additional labels or to update a label for an existing dataset, callthedatasets.patchmethod and add to or update thelabels property for thedataset resource.

Because thedatasets.update method replaces the entire dataset resource,thedatasets.patch method is preferred.

Go

import("context""fmt""cloud.google.com/go/bigquery")// addDatasetLabel demonstrates adding label metadata to an existing dataset.funcaddDatasetLabel(projectID,datasetIDstring)error{// projectID := "my-project-id"// datasetID := "mydataset"ctx:=context.Background()client,err:=bigquery.NewClient(ctx,projectID)iferr!=nil{returnfmt.Errorf("bigquery.NewClient: %v",err)}deferclient.Close()ds:=client.Dataset(datasetID)meta,err:=ds.Metadata(ctx)iferr!=nil{returnerr}update:=bigquery.DatasetMetadataToUpdate{}update.SetLabel("color","green")if_,err:=ds.Update(ctx,update,meta.ETag);err!=nil{returnerr}returnnil}

Java

This sample uses theGoogle HTTP Client Library forJavato send a request to the BigQuery API.

importcom.google.cloud.bigquery.BigQuery;importcom.google.cloud.bigquery.BigQueryException;importcom.google.cloud.bigquery.BigQueryOptions;importcom.google.cloud.bigquery.Dataset;importjava.util.HashMap;importjava.util.Map;// Sample to updates a label on datasetpublicclassLabelDataset{publicstaticvoidrunLabelDataset(){// TODO(developer): Replace these variables before running the sample.StringdatasetName="MY_DATASET_NAME";labelDataset(datasetName);}publicstaticvoidlabelDataset(StringdatasetName){try{// Initialize client that will be used to send requests. This client only needs to be created// once, and can be reused for multiple requests.BigQuerybigquery=BigQueryOptions.getDefaultInstance().getService();// This example dataset starts with existing label { color: 'green' }Datasetdataset=bigquery.getDataset(datasetName);// Add label to datasetMap<String,String>labels=newHashMap<>();labels.put("color","green");dataset.toBuilder().setLabels(labels).build().update();System.out.println("Label added successfully");}catch(BigQueryExceptione){System.out.println("Label was not added. \n"+e.toString());}}}

Node.js

// Import the Google Cloud client libraryconst{BigQuery}=require('@google-cloud/bigquery');constbigquery=newBigQuery();asyncfunctionlabelDataset(){// Updates a label on a dataset./**   * TODO(developer): Uncomment the following lines before running the sample   */// const datasetId = "my_dataset";// Retrieve current dataset metadata.constdataset=bigquery.dataset(datasetId);const[metadata]=awaitdataset.getMetadata();// Add label to dataset metadatametadata.labels={color:'green'};const[apiResponse]=awaitdataset.setMetadata(metadata);console.log(`${datasetId} labels:`);console.log(apiResponse.labels);}

Python

fromgoogle.cloudimportbigquery# Construct a BigQuery client object.client=bigquery.Client()# TODO(developer): Set dataset_id to the ID of the dataset to fetch.# dataset_id = "your-project.your_dataset"dataset=client.get_dataset(dataset_id)# Make an API request.dataset.labels={"color":"green"}dataset=client.update_dataset(dataset,["labels"])# Make an API request.print("Labels added to{}".format(dataset_id))

Console

1. In the Google Cloud console, select the table or view.

2. Click theDetails tab, and then click the pencil icon to the right ofLabels.

3. In theEdit labels dialog:

   • To apply additional labels, clickAdd label. Each key can be usedonly once per table or view, but you can use the same key in tables orviews in different datasets.
   • Modify the existing keys or values to update a label.
   • ClickUpdate to save your changes.

SQL

Use theALTER TABLE SET OPTIONS DDL statementto set the labels on an existing table, or theALTER VIEW SET OPTIONS DDL statementto set the labels on an existing view. Setting labels overwrites anyexisting labels on the table or view. The following example sets two labelson the tablemytable:

1. In the Google Cloud console, go to theBigQuery page.

   Go to BigQuery

2. In the query editor, enter the following statement:

   ALTERTABLEmydataset.mytableSETOPTIONS(labels=[('department','shipping'),('cost_center','logistics')]);

3. Clickplay_circleRun.

For more information about how to run queries, seeRun an interactive query.

bq

To add additional labels or to update a table or view label, issue thebqupdate command with theset_label flag. Repeat the flag to add or updatemultiple labels.

If the table or view is in a project other than your default project, addthe project ID to the dataset in the following format:project_id:dataset.

bqupdate\--set_labelkey:value\project_id:dataset.table_or_view

Where:

• key:value corresponds to a key:value pair for a label that youwant to add or update. If you specify the same key as an existing label, thevalue for the existing label is updated. The key must be unique.
• project_id is your project ID.
• dataset is the dataset that contains the table or view you'reupdating.
• table_or_view is the name of the table or view you're updating.

Example:

To update thedepartment label formytable, enter thebq updatecommand and specifydepartment as the label key. For example, to updatethedepartment:shipping label todepartment:logistics formytable,enter the following command.mytable is inmyotherproject, not yourdefault project.

    bq update \    --set_label department:logistics \    myotherproject:mydataset.mytable

The output looks like the following:

Table 'myotherproject:mydataset.mytable' successfully updated.

API

To add labels or to update a label for an existing table or view,call thetables.patchmethod and add to or update thelabelsproperty for thetable resource.

Because views are treated like table resources, you use thetables.patchmethod to modify both views and tables.

Because thetables.update method replaces the entire dataset resource, thetables.patch method is preferred.

Go

import("context""fmt""cloud.google.com/go/bigquery")// addTableLabel demonstrates adding Label metadata to a BigQuery table.funcaddTableLabel(projectID,datasetID,tableIDstring)error{// projectID := "my-project-id"// datasetID := "mydataset"// tableID := "mytable"ctx:=context.Background()client,err:=bigquery.NewClient(ctx,projectID)iferr!=nil{returnfmt.Errorf("bigquery.NewClient: %v",err)}deferclient.Close()tbl:=client.Dataset(datasetID).Table(tableID)meta,err:=tbl.Metadata(ctx)iferr!=nil{returnerr}update:=bigquery.TableMetadataToUpdate{}update.SetLabel("color","green")if_,err:=tbl.Update(ctx,update,meta.ETag);err!=nil{returnerr}returnnil}

Java

This sample uses theGoogle HTTP Client Library for Javato send a request to the BigQuery API.

importcom.google.cloud.bigquery.BigQuery;importcom.google.cloud.bigquery.BigQueryException;importcom.google.cloud.bigquery.BigQueryOptions;importcom.google.cloud.bigquery.Table;importcom.google.cloud.bigquery.TableId;importjava.util.HashMap;importjava.util.Map;// Sample to adds a label to an existing tablepublicclassLabelTable{publicstaticvoidrunLabelTable(){// TODO(developer): Replace these variables before running the sample.StringdatasetName="MY_DATASET_NAME";StringtableName="MY_TABLE_NAME";labelTable(datasetName,tableName);}publicstaticvoidlabelTable(StringdatasetName,StringtableName){try{// Initialize client that will be used to send requests. This client only needs to be created// once, and can be reused for multiple requests.BigQuerybigquery=BigQueryOptions.getDefaultInstance().getService();// This example table starts with existing label { color: 'green' }Tabletable=bigquery.getTable(TableId.of(datasetName,tableName));// Add label to tableMap<String,String>labels=newHashMap<>();labels.put("color","green");table.toBuilder().setLabels(labels).build().update();System.out.println("Label added successfully");}catch(BigQueryExceptione){System.out.println("Label was not added. \n"+e.toString());}}}

Node.js

// Import the Google Cloud client libraryconst{BigQuery}=require('@google-cloud/bigquery');constbigquery=newBigQuery();asyncfunctionlabelTable(){// Adds a label to an existing table./**   * TODO(developer): Uncomment the following lines before running the sample.   */// const datasetId = 'my_dataset';// const tableId = 'my_table';constdataset=bigquery.dataset(datasetId);const[table]=awaitdataset.table(tableId).get();// Retrieve current table metadataconst[metadata]=awaittable.getMetadata();// Add label to table metadatametadata.labels={color:'green'};const[apiResponse]=awaittable.setMetadata(metadata);console.log(`${tableId} labels:`);console.log(apiResponse.labels);}

Python

# from google.cloud import bigquery# client = bigquery.Client()# project = client.project# dataset_ref = bigquery.DatasetReference(project, dataset_id)# table_ref = dataset_ref.table('my_table')# table = client.get_table(table_ref)  # API requestasserttable.labels=={}labels={"color":"green"}table.labels=labelstable=client.update_table(table,["labels"])# API requestasserttable.labels==labels

Console

1. In the Google Cloud console, go to the BigQuery page.

   Go to BigQuery

2. In the navigation menu, clickCapacity management.

3. Click theSlot reservations tab.

4. Find the reservation you want to update.

5. Expand themore_vertActions option.

6. ClickEdit.

7. To expand theAdvanced settings section, click theexpand_moreexpander arrow.

8. Update the names of the key-value pair.

9. ClickSave.

bq

To update a label to a reservation, issue thebq update command with theset_label flag and--reservation flag. To update multiple labels, repeat the flag.

bqupdate--set_labelKEY:VALUE--reservationRESERVATION_NAME

Replace the following:

• KEY:VALUE: a key-value pair for a label that youwant to update on the reservation. The key must be unique. Keys and values cancontain only lowercase letters, numeric characters, underscores, anddashes. All characters must use UTF-8 encoding, and internationalcharacters are allowed. To update multiple labels on a reservation, repeat the--label flag and specify a unique keyfor each label.
• RESERVATION_NAME: the name of the reservation.

SQL

To update a label to a reservation, use theALTER RESERVATION SET OPTIONS DDLstatementto set the labels on an existing reservation. Setting labels overwrites anyexisting labels on the reservation. The following example sets a label on thereservationmyreservation:

1. In the Google Cloud console, go to theBigQuery page.

   Go to BigQuery

2. In the query editor, enter the following statement:

   ALTERRESERVATIONmyreservationSETOPTIONS(labels=[('sensitivity','high')]);

3. Clickplay_circleRun.

For more information about how to run queries, seeRun an interactive query.

Console

1. In the Google Cloud console, select the dataset, table, or view.

2. For datasets, the dataset details page is automatically opened. Fortables and views, clickDetails to open the details page.

   

3. On the details page, click the pencil icon to the right ofLabels.

   

4. In theEdit labels dialog:

   • Delete the value for an existing label.
   • ClickUpdate.

bq

To convert a label to a tag, use thebq update command with theset_label flag. Specify the key, followed by a colon, but leave the valueunspecified. This updates an existing label to a tag.

bqupdate\--set_labelkey:\resource_id

Where:

• key: is the label key that you want update to a tag.
• resource_id is a valid dataset, table, or view name. If theresource is in a project other than your default project, add the project IDin the following format:project_id:dataset.

Examples:

Enter the following command to change the existingtest_data:developmentlabel onmydataset to a tag.mydataset is inmyotherproject, not yourdefault project.

bq update --set_label test_data: myotherproject:mydataset

The output looks like the following:

Dataset 'myotherproject:mydataset' successfully updated.

API

To turn an existing label into a tag, call thedatasets.patchmethod or thetables.patchmethod and replace the label values with the empty string ("") in thedataset resourceor thetable resource.

Because views are treated like table resources, you use thetables.patchmethod to modify both views and tables. Also, because thetables.updatemethod replaces the entire dataset resource, thetables.patch method ispreferred.