Update default table expiration times Stay organized with collections Save and categorize content based on your preferences.
Updates a dataset's default table expiration times.
Explore further
For detailed documentation that includes this code sample, see the following:
Code sample
Go
Before trying this sample, follow theGo setup instructions in theBigQuery quickstart using client libraries. For more information, see theBigQueryGo API reference documentation.
To authenticate to BigQuery, set up Application Default Credentials. For more information, seeSet up authentication for client libraries.
import("context""fmt""time""cloud.google.com/go/bigquery")// updateDatasetDefaultExpiration demonstrats setting the default expiration of a dataset// to a specific retention period.funcupdateDatasetDefaultExpiration(projectID,datasetIDstring)error{// projectID := "my-project-id"// datasetID := "mydataset"ctx:=context.Background()client,err:=bigquery.NewClient(ctx,projectID)iferr!=nil{returnfmt.Errorf("bigquery.NewClient: %w",err)}deferclient.Close()ds:=client.Dataset(datasetID)meta,err:=ds.Metadata(ctx)iferr!=nil{returnerr}update:=bigquery.DatasetMetadataToUpdate{DefaultTableExpiration:24*time.Hour,}if_,err:=client.Dataset(datasetID).Update(ctx,update,meta.ETag);err!=nil{returnerr}returnnil}Java
Before trying this sample, follow theJava setup instructions in theBigQuery quickstart using client libraries. For more information, see theBigQueryJava API reference documentation.
To authenticate to BigQuery, set up Application Default Credentials. For more information, seeSet up authentication for client libraries.
importcom.google.cloud.bigquery.BigQuery;importcom.google.cloud.bigquery.BigQueryException;importcom.google.cloud.bigquery.BigQueryOptions;importcom.google.cloud.bigquery.Dataset;importjava.util.concurrent.TimeUnit;publicclassUpdateDatasetExpiration{publicstaticvoidmain(String[]args){// TODO(developer): Replace these variables before running the sample.StringdatasetName="MY_DATASET_NAME";// Update dataset expiration to one dayLongnewExpiration=TimeUnit.MILLISECONDS.convert(1,TimeUnit.DAYS);updateDatasetExpiration(datasetName,newExpiration);}publicstaticvoidupdateDatasetExpiration(StringdatasetName,LongnewExpiration){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();Datasetdataset=bigquery.getDataset(datasetName);bigquery.update(dataset.toBuilder().setDefaultTableLifetime(newExpiration).build());System.out.println("Dataset description updated successfully to "+newExpiration);}catch(BigQueryExceptione){System.out.println("Dataset expiration was not updated \n"+e.toString());}}}Node.js
Before trying this sample, follow theNode.js setup instructions in theBigQuery quickstart using client libraries. For more information, see theBigQueryNode.js API reference documentation.
To authenticate to BigQuery, set up Application Default Credentials. For more information, seeSet up authentication for client libraries.
// Import the Google Cloud client libraryconst{BigQuery}=require('@google-cloud/bigquery');constbigquery=newBigQuery();asyncfunctionupdateDatasetExpiration(){// Updates the lifetime of all tables in the dataset, in milliseconds./** * TODO(developer): Uncomment the following lines before running the sample. */// const datasetId = "my_dataset";// Retreive current dataset metadataconstdataset=bigquery.dataset(datasetId);const[metadata]=awaitdataset.getMetadata();// Set new dataset metadataconstexpirationTime=24*60*60*1000;metadata.defaultTableExpirationMs=expirationTime.toString();const[apiResponse]=awaitdataset.setMetadata(metadata);constnewExpirationTime=apiResponse.defaultTableExpirationMs;console.log(`${datasetId} expiration:${newExpirationTime}`);}Python
Before trying this sample, follow thePython setup instructions in theBigQuery quickstart using client libraries. For more information, see theBigQueryPython API reference documentation.
To authenticate to BigQuery, set up Application Default Credentials. For more information, seeSet up authentication for client libraries.
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.default_table_expiration_ms=24*60*60*1000# In milliseconds.dataset=client.update_dataset(dataset,["default_table_expiration_ms"])# Make an API request.full_dataset_id="{}.{}".format(dataset.project,dataset.dataset_id)print("Updated dataset{} with new expiration{}".format(full_dataset_id,dataset.default_table_expiration_ms))What's next
To search and filter code samples for other Google Cloud products, see theGoogle Cloud sample browser.
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.