Update a view query

Update a view's query.

Explore further

For detailed documentation that includes this code sample, see the following:

Code sample

Go

Before trying this sample, follow the Go setup instructions in the BigQuery quickstart using client libraries . For more information, see the BigQuery Go API reference documentation .

To authenticate to BigQuery, set up Application Default Credentials. For more information, see Set up authentication for client libraries .

  import 
  
 ( 
  
 "context" 
  
 "fmt" 
  
 "cloud.google.com/go/bigquery" 
 ) 
 // updateView demonstrates updating the query metadata that defines a logical view. 
 func 
  
 updateView 
 ( 
 projectID 
 , 
  
 datasetID 
 , 
  
 viewID 
  
 string 
 ) 
  
 error 
  
 { 
  
 // projectID := "my-project-id" 
  
 // datasetID := "mydataset" 
  
 // viewID := "myview" 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 client 
 , 
  
 err 
  
 := 
  
 bigquery 
 . 
 NewClient 
 ( 
 ctx 
 , 
  
 projectID 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 fmt 
 . 
 Errorf 
 ( 
 "bigquery.NewClient: %w" 
 , 
  
 err 
 ) 
  
 } 
  
 defer 
  
 client 
 . 
 Close 
 () 
  
 view 
  
 := 
  
 client 
 . 
 Dataset 
 ( 
 datasetID 
 ). 
 Table 
 ( 
 viewID 
 ) 
  
 meta 
 , 
  
 err 
  
 := 
  
 view 
 . 
 Metadata 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 err 
  
 } 
  
 newMeta 
  
 := 
  
 bigquery 
 . 
  TableMetadataToUpdate 
 
 { 
  
 // This example updates a view into the shakespeare dataset to exclude works named after kings. 
  
 ViewQuery 
 : 
  
 "SELECT word, word_count, corpus, corpus_date FROM `bigquery-public-data.samples.shakespeare` WHERE corpus NOT LIKE '%king%'" 
 , 
  
 } 
  
 if 
  
 _ 
 , 
  
 err 
  
 := 
  
 view 
 . 
 Update 
 ( 
 ctx 
 , 
  
 newMeta 
 , 
  
 meta 
 . 
 ETag 
 ); 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 err 
  
 } 
  
 return 
  
 nil 
 } 
 

Java

Before trying this sample, follow the Java setup instructions in the BigQuery quickstart using client libraries . For more information, see the BigQuery Java API reference documentation .

To authenticate to BigQuery, set up Application Default Credentials. For more information, see Set up authentication for client libraries .

  import 
  
 com.google.cloud.bigquery. BigQuery 
 
 ; 
 import 
  
 com.google.cloud.bigquery. BigQueryException 
 
 ; 
 import 
  
 com.google.cloud.bigquery. BigQueryOptions 
 
 ; 
 import 
  
 com.google.cloud.bigquery. TableId 
 
 ; 
 import 
  
 com.google.cloud.bigquery. TableInfo 
 
 ; 
 import 
  
 com.google.cloud.bigquery. ViewDefinition 
 
 ; 
 // Sample to update query on a view 
 public 
  
 class 
 UpdateViewQuery 
  
 { 
  
 public 
  
 static 
  
 void 
  
 main 
 ( 
 String 
 [] 
  
 args 
 ) 
  
 { 
  
 // TODO(developer): Replace these variables before running the sample. 
  
 String 
  
 datasetName 
  
 = 
  
 "MY_DATASET_NAME" 
 ; 
  
 String 
  
 tableName 
  
 = 
  
 "MY_TABLE_NAME" 
 ; 
  
 String 
  
 viewName 
  
 = 
  
 "MY_VIEW_NAME" 
 ; 
  
 String 
  
 updateQuery 
  
 = 
  
 String 
 . 
 format 
 ( 
 "SELECT TimestampField, StringField FROM %s.%s" 
 , 
  
 datasetName 
 , 
  
 tableName 
 ); 
  
 updateViewQuery 
 ( 
 datasetName 
 , 
  
 viewName 
 , 
  
 updateQuery 
 ); 
  
 } 
  
 public 
  
 static 
  
 void 
  
 updateViewQuery 
 ( 
 String 
  
 datasetName 
 , 
  
 String 
  
 viewName 
 , 
  
 String 
  
 query 
 ) 
  
 { 
  
 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. 
  
  BigQuery 
 
  
 bigquery 
  
 = 
  
  BigQueryOptions 
 
 . 
 getDefaultInstance 
 (). 
 getService 
 (); 
  
 // Retrieve existing view metadata 
  
  TableInfo 
 
  
 viewMetadata 
  
 = 
  
 bigquery 
 . 
  getTable 
 
 ( 
 TableId 
 . 
 of 
 ( 
 datasetName 
 , 
  
 viewName 
 )); 
  
 // Update view query 
  
  ViewDefinition 
 
  
 viewDefinition 
  
 = 
  
 viewMetadata 
 . 
  getDefinition 
 
 (); 
  
  ViewDefinition 
 
  
 updatedViewDefinition 
  
 = 
  
 viewDefinition 
 . 
  toBuilder 
 
 (). 
 setQuery 
 ( 
 query 
 ). 
 build 
 (); 
  
 // Set metadata 
  
 bigquery 
 . 
  update 
 
 ( 
 viewMetadata 
 . 
 toBuilder 
 (). 
 setDefinition 
 ( 
  update 
 
dViewDefinition ). 
 build 
 ()); 
  
 System 
 . 
 out 
 . 
 println 
 ( 
 "View query updated successfully" 
 ); 
  
 } 
  
 catch 
  
 ( 
  BigQueryException 
 
  
 e 
 ) 
  
 { 
  
 System 
 . 
 out 
 . 
 println 
 ( 
 "View query was not updated. \n" 
  
 + 
  
 e 
 . 
 toString 
 ()); 
  
 } 
  
 } 
 } 
 

Node.js

Before trying this sample, follow the Node.js setup instructions in the BigQuery quickstart using client libraries . For more information, see the BigQuery Node.js API reference documentation .

To authenticate to BigQuery, set up Application Default Credentials. For more information, see Set up authentication for client libraries .

  // Import the Google Cloud client library and create a client 
 const 
  
 { 
 BigQuery 
 } 
  
 = 
  
 require 
 ( 
 ' @google-cloud/bigquery 
' 
 ); 
 const 
  
 bigquery 
  
 = 
  
 new 
  
  BigQuery 
 
 (); 
 async 
  
 function 
  
 updateViewQuery 
 () 
  
 { 
  
 // Updates a view named "my_existing_view" in "my_dataset". 
  
 /** 
 * TODO(developer): Uncomment the following lines before running the sample. 
 */ 
  
 // const datasetId = "my_existing_dataset" 
  
 // const tableId = "my_existing_table" 
  
 const 
  
 dataset 
  
 = 
  
 await 
  
 bigquery 
 . 
 dataset 
 ( 
 datasetId 
 ); 
  
 // This example updates a view into the USA names dataset to include state. 
  
 const 
  
 newViewQuery 
  
 = 
  
 `SELECT name, state 
 FROM \`bigquery-public-data.usa_names.usa_1910_current\` 
 LIMIT 10` 
 ; 
  
 // Retrieve existing view 
  
 const 
  
 [ 
 view 
 ] 
  
 = 
  
 await 
  
 dataset 
 . 
 table 
 ( 
 tableId 
 ). 
 get 
 (); 
  
 // Retrieve existing view metadata 
  
 const 
  
 [ 
 metadata 
 ] 
  
 = 
  
 await 
  
 view 
 . 
 getMetadata 
 (); 
  
 // Update view query 
  
 metadata 
 . 
 view 
  
 = 
  
 newViewQuery 
 ; 
  
 // Set metadata 
  
 await 
  
 view 
 . 
 setMetadata 
 ( 
 metadata 
 ); 
  
 console 
 . 
 log 
 ( 
 `View 
 ${ 
 tableId 
 } 
 updated.` 
 ); 
 } 
 

Python

Before trying this sample, follow the Python setup instructions in the BigQuery quickstart using client libraries . For more information, see the BigQuery Python API reference documentation .

To authenticate to BigQuery, set up Application Default Credentials. For more information, see Set up authentication for client libraries .

  from 
  
 google.cloud 
  
 import 
  bigquery 
 
 client 
 = 
  bigquery 
 
 . 
  Client 
 
 () 
 view_id 
 = 
 "my-project.my_dataset.my_view" 
 source_id 
 = 
 "my-project.my_dataset.my_table" 
 view 
 = 
  bigquery 
 
 . 
  Table 
 
 ( 
 view_id 
 ) 
 # The source table in this example is created from a CSV file in Google 
 # Cloud Storage located at 
 # `gs://cloud-samples-data/bigquery/us-states/us-states.csv`. It contains 
 # 50 US states, while the view returns only those states with names 
 # starting with the letter 'M'. 
  view 
 
 . 
  view_query 
 
 = 
 f 
 "SELECT name, post_abbr FROM ` 
 { 
 source_id 
 } 
 ` WHERE name LIKE 'M%'" 
 # Make an API request to update the query property of the view. 
 view 
 = 
 client 
 . 
  update_table 
 
 ( 
 view 
 , 
 [ 
 "view_query" 
 ]) 
 print 
 ( 
 f 
 "Updated 
 { 
  view 
 
 . 
 table_type 
 } 
 : 
 { 
 str 
 ( 
  view 
 
 . 
 reference 
 ) 
 } 
 " 
 ) 
 

What's next

To search and filter code samples for other Google Cloud products, see the Google Cloud sample browser .

Design a Mobile Site
View Site in Mobile | Classic
Share by: