Get view properties

Retrieve the properties of a view for a given view ID.

Explore further

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

Getting information about views

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" 
  
 "io" 
  
 "cloud.google.com/go/bigquery" 
 ) 
 // getView demonstrates fetching the metadata from a BigQuery logical view and printing it to an io.Writer. 
 func 
  
 getView 
 ( 
 w 
  
 io 
 . 
 Writer 
 , 
  
 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 
  
 } 
  
 fmt 
 . 
 Fprintf 
 ( 
 w 
 , 
  
 "View %s, query: %s\n" 
 , 
  
 view 
 . 
 FullyQualifiedName 
 (), 
  
 meta 
 . 
 ViewQuery 
 ) 
  
 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. Table 
 
 ; 
 import 
  
 com.google.cloud.bigquery. TableId 
 
 ; 
 // Sample to get a view 
 public 
  
 class 
 GetView 
  
 { 
  
 public 
  
 static 
  
 void 
  
 main 
 ( 
 String 
 [] 
  
 args 
 ) 
  
 { 
  
 // TODO(developer): Replace these variables before running the sample. 
  
 String 
  
 datasetName 
  
 = 
  
 "MY_DATASET_NAME" 
 ; 
  
 String 
  
 viewName 
  
 = 
  
 "MY_VIEW_NAME" 
 ; 
  
 getView 
 ( 
 datasetName 
 , 
  
 viewName 
 ); 
  
 } 
  
 public 
  
 static 
  
 void 
  
 getView 
 ( 
 String 
  
 datasetName 
 , 
  
 String 
  
 viewName 
 ) 
  
 { 
  
 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 
 (); 
  
  TableId 
 
  
 tableId 
  
 = 
  
  TableId 
 
 . 
 of 
 ( 
 datasetName 
 , 
  
 viewName 
 ); 
  
  Table 
 
  
 view 
  
 = 
  
 bigquery 
 . 
  getTable 
 
 ( 
 tableId 
 ); 
  
 System 
 . 
 out 
 . 
 println 
 ( 
 "View retrieved successfully" 
  
 + 
  
 view 
 . 
 getDescription 
 ()); 
  
 } 
  
 catch 
  
 ( 
  BigQueryException 
 
  
 e 
 ) 
  
 { 
  
 System 
 . 
 out 
 . 
 println 
 ( 
 "View not retrieved. \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 
 const 
  
 { 
 BigQuery 
 } 
  
 = 
  
 require 
 ( 
 ' @google-cloud/bigquery 
' 
 ); 
 const 
  
 bigquery 
  
 = 
  
 new 
  
  BigQuery 
 
 (); 
 async 
  
 function 
  
 getView 
 () 
  
 { 
  
 // Retrieves view properties. 
  
 /** 
 * TODO(developer): Uncomment the following lines before running the sample 
 */ 
  
 // const datasetId = "my_dataset"; 
  
 // const tableId = "my_view"; 
  
 // Retrieve view 
  
 const 
  
 dataset 
  
 = 
  
 bigquery 
 . 
 dataset 
 ( 
 datasetId 
 ); 
  
 const 
  
 [ 
 view 
 ] 
  
 = 
  
 await 
  
 dataset 
 . 
 table 
 ( 
 tableId 
 ). 
 get 
 (); 
  
 const 
  
 fullTableId 
  
 = 
  
 view 
 . 
 metadata 
 . 
 id 
 ; 
  
 const 
  
 viewQuery 
  
 = 
  
 view 
 . 
 metadata 
 . 
 view 
 . 
 query 
 ; 
  
 // Display view properties 
  
 console 
 . 
 log 
 ( 
 `View at 
 ${ 
 fullTableId 
 } 
 ` 
 ); 
  
 console 
 . 
 log 
 ( 
 `View query: 
 ${ 
 viewQuery 
 } 
 ` 
 ); 
 } 
 getView 
 ();

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" 
 # Make an API request to get the table resource. 
 view 
 = 
 client 
 . 
  get_table 
 
 ( 
 view_id 
 ) 
 # Display view properties 
 print 
 ( 
 f 
 "Retrieved 
 { 
  view 
 
 . 
 table_type 
 } 
 : 
 { 
 str 
 ( 
  view 
 
 . 
 reference 
 ) 
 } 
 " 
 ) 
 print 
 ( 
 f 
 "View Query: 
 \n 
 { 
  view 
 
 . 
  view_query 
 
 } 
 " 
 )

What's next

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

Get view properties Stay organized with collections Save and categorize content based on your preferences.

Explore further

Code sample

Go

Java

Node.js

Python

What's next

Get view properties