Get dataset properties

Retrieve the properties of a dataset.

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" 
  
 "io" 
  
 "cloud.google.com/go/bigquery" 
  
 "google.golang.org/api/iterator" 
 ) 
 // printDatasetInfo demonstrates fetching dataset metadata and printing some of it to an io.Writer. 
 func 
  
 printDatasetInfo 
 ( 
 w 
  
 io 
 . 
 Writer 
 , 
  
 projectID 
 , 
  
 datasetID 
  
 string 
 ) 
  
 error 
  
 { 
  
 // projectID := "my-project-id" 
  
 // datasetID := "mydataset" 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 client 
 , 
  
 err 
  
 := 
  
 bigquery 
 . 
 NewClient 
 ( 
 ctx 
 , 
  
 projectID 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 fmt 
 . 
 Errorf 
 ( 
 "bigquery.NewClient: %w" 
 , 
  
 err 
 ) 
  
 } 
  
 defer 
  
 client 
 . 
 Close 
 () 
  
 meta 
 , 
  
 err 
  
 := 
  
 client 
 . 
 Dataset 
 ( 
 datasetID 
 ). 
 Metadata 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 err 
  
 } 
  
 fmt 
 . 
 Fprintf 
 ( 
 w 
 , 
  
 "Dataset ID: %s\n" 
 , 
  
 datasetID 
 ) 
  
 fmt 
 . 
 Fprintf 
 ( 
 w 
 , 
  
 "Description: %s\n" 
 , 
  
 meta 
 . 
 Description 
 ) 
  
 fmt 
 . 
 Fprintln 
 ( 
 w 
 , 
  
 "Labels:" 
 ) 
  
 for 
  
 k 
 , 
  
 v 
  
 := 
  
 range 
  
 meta 
 . 
 Labels 
  
 { 
  
 fmt 
 . 
 Fprintf 
 ( 
 w 
 , 
  
 "\t%s: %s" 
 , 
  
 k 
 , 
  
 v 
 ) 
  
 } 
  
 fmt 
 . 
 Fprintln 
 ( 
 w 
 , 
  
 "Tables:" 
 ) 
  
 it 
  
 := 
  
 client 
 . 
 Dataset 
 ( 
 datasetID 
 ). 
  Tables 
 
 ( 
 ctx 
 ) 
  
 cnt 
  
 := 
  
 0 
  
 for 
  
 { 
  
 t 
 , 
  
 err 
  
 := 
  
 it 
 . 
 Next 
 () 
  
 if 
  
 err 
  
 == 
  
 iterator 
 . 
 Done 
  
 { 
  
 break 
  
 } 
  
 cnt 
 ++ 
  
 fmt 
 . 
 Fprintf 
 ( 
 w 
 , 
  
 "\t%s\n" 
 , 
  
 t 
 . 
 TableID 
 ) 
  
 } 
  
 if 
  
 cnt 
  
 == 
  
 0 
  
 { 
  
 fmt 
 . 
 Fprintln 
 ( 
 w 
 , 
  
 "\tThis dataset does not contain any tables." 
 ) 
  
 } 
  
 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.api.gax.paging. Page 
 
 ; 
 import 
  
 com.google.cloud.bigquery. BigQuery 
 
 ; 
 import 
  
 com.google.cloud.bigquery. BigQuery 
. TableListOption 
 
 ; 
 import 
  
 com.google.cloud.bigquery. BigQueryException 
 
 ; 
 import 
  
 com.google.cloud.bigquery. BigQueryOptions 
 
 ; 
 import 
  
 com.google.cloud.bigquery. Dataset 
 
 ; 
 import 
  
 com.google.cloud.bigquery. DatasetId 
 
 ; 
 import 
  
 com.google.cloud.bigquery. Table 
 
 ; 
 public 
  
 class 
 GetDatasetInfo 
  
 { 
  
 public 
  
 static 
  
 void 
  
 main 
 ( 
 String 
 [] 
  
 args 
 ) 
  
 { 
  
 // TODO(developer): Replace these variables before running the sample. 
  
 String 
  
 projectId 
  
 = 
  
 "MY_PROJECT_ID" 
 ; 
  
 String 
  
 datasetName 
  
 = 
  
 "MY_DATASET_NAME" 
 ; 
  
 getDatasetInfo 
 ( 
 projectId 
 , 
  
 datasetName 
 ); 
  
 } 
  
 public 
  
 static 
  
 void 
  
 getDatasetInfo 
 ( 
 String 
  
 projectId 
 , 
  
 String 
  
 datasetName 
 ) 
  
 { 
  
 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 
 (); 
  
  DatasetId 
 
  
 datasetId 
  
 = 
  
  DatasetId 
 
 . 
 of 
 ( 
 projectId 
 , 
  
 datasetName 
 ); 
  
  Dataset 
 
  
 dataset 
  
 = 
  
 bigquery 
 . 
  getDataset 
 
 ( 
 datasetId 
 ); 
  
 // View dataset properties 
  
 String 
  
 description 
  
 = 
  
 dataset 
 . 
 getDescription 
 (); 
  
 System 
 . 
 out 
 . 
 println 
 ( 
 description 
 ); 
  
 // View tables in the dataset 
  
 // For more information on listing tables see: 
  
 // https://javadoc.io/static/com.google.cloud/google-cloud-bigquery/0.22.0-beta/com/google/cloud/bigquery/BigQuery.html 
  
 Page<Table> 
  
 tables 
  
 = 
  
 bigquery 
 . 
  listTables 
 
 ( 
 datasetName 
 , 
  
 TableListOption 
 . 
 pageSize 
 ( 
 100 
 )); 
  
 tables 
 . 
 iterateAll 
 (). 
 forEach 
 ( 
 table 
  
 - 
>  
 System 
 . 
 out 
 . 
 print 
 ( 
 table 
 . 
 getTableId 
 (). 
 getTable 
 () 
  
 + 
  
 "\n" 
 )); 
  
 System 
 . 
 out 
 . 
 println 
 ( 
 "Dataset info retrieved successfully." 
 ); 
  
 } 
  
 catch 
  
 ( 
  BigQueryException 
 
  
 e 
 ) 
  
 { 
  
 System 
 . 
 out 
 . 
 println 
 ( 
 "Dataset info 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 
  
 getDataset 
 () 
  
 { 
  
 // Retrieves dataset named "my_dataset". 
  
 /** 
 * TODO(developer): Uncomment the following lines before running the sample 
 */ 
  
 // const datasetId = "my_dataset"; 
  
 // Retrieve dataset reference 
  
 const 
  
 [ 
 dataset 
 ] 
  
 = 
  
 await 
  
 bigquery 
 . 
 dataset 
 ( 
 datasetId 
 ). 
 get 
 (); 
  
 console 
 . 
 log 
 ( 
 'Dataset:' 
 ); 
  
 console 
 . 
 log 
 ( 
 dataset 
 . 
 metadata 
 . 
 datasetReference 
 ); 
 } 
 getDataset 
 (); 
 

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 
 
 # 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. 
 full_dataset_id 
 = 
 " 
 {} 
 . 
 {} 
 " 
 . 
 format 
 ( 
 dataset 
 . 
 project 
 , 
 dataset 
 . 
 dataset_id 
 ) 
 friendly_name 
 = 
 dataset 
 . 
 friendly_name 
 print 
 ( 
 "Got dataset ' 
 {} 
 ' with friendly_name ' 
 {} 
 '." 
 . 
 format 
 ( 
 full_dataset_id 
 , 
 friendly_name 
 ) 
 ) 
 # View dataset properties. 
 print 
 ( 
 "Description: 
 {} 
 " 
 . 
 format 
 ( 
 dataset 
 . 
 description 
 )) 
 print 
 ( 
 "Labels:" 
 ) 
 labels 
 = 
 dataset 
 . 
 labels 
 if 
 labels 
 : 
 for 
 label 
 , 
 value 
 in 
 labels 
 . 
  items 
 
 (): 
 print 
 ( 
 " 
 \t 
 {} 
 : 
 {} 
 " 
 . 
 format 
 ( 
 label 
 , 
 value 
 )) 
 else 
 : 
 print 
 ( 
 " 
 \t 
 Dataset has no labels defined." 
 ) 
 # View tables in dataset. 
 print 
 ( 
 "Tables:" 
 ) 
 tables 
 = 
 list 
 ( 
 client 
 . 
  list_tables 
 
 ( 
 dataset 
 )) 
 # Make an API request(s). 
 if 
 tables 
 : 
 for 
 table 
 in 
 tables 
 : 
 print 
 ( 
 " 
 \t 
 {} 
 " 
 . 
 format 
 ( 
 table 
 . 
 table_id 
 )) 
 else 
 : 
 print 
 ( 
 " 
 \t 
 This dataset does not contain any tables." 
 ) 
 

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: