List datasets

Lists all existing datasets in a project.

Explore further

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

Code sample

C#

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

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

  using 
  
  Google.Cloud.BigQuery.V2 
 
 ; 
 using 
  
 System 
 ; 
 using 
  
 System.Collections.Generic 
 ; 
 using 
  
 System.Linq 
 ; 
 public 
  
 class 
  
 BigQueryListDatasets 
 { 
  
 public 
  
 void 
  
 ListDatasets 
 ( 
  
 string 
  
 projectId 
  
 = 
  
 "your-project-id" 
  
 ) 
  
 { 
  
  BigQueryClient 
 
  
 client 
  
 = 
  
  BigQueryClient 
 
 . 
  Create 
 
 ( 
 projectId 
 ); 
  
 // Retrieve list of datasets in project 
  
 List<BigQueryDataset> 
  
 datasets 
  
 = 
  
 client 
 . 
  ListDatasets 
 
 (). 
 ToList 
 (); 
  
 // Display the results 
  
 if 
  
 ( 
 datasets 
 . 
 Count 
 > 
 0 
 ) 
  
 { 
  
 Console 
 . 
 WriteLine 
 ( 
 $"Datasets in project {projectId}:" 
 ); 
  
 foreach 
  
 ( 
 var 
  
 dataset 
  
 in 
  
 datasets 
 ) 
  
 { 
  
 Console 
 . 
 WriteLine 
 ( 
 $"\t{dataset.Reference.DatasetId}" 
 ); 
  
 } 
  
 } 
  
 else 
  
 { 
  
 Console 
 . 
 WriteLine 
 ( 
 $"{projectId} does not contain any datasets." 
 ); 
  
 } 
  
 } 
 } 
 

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" 
 ) 
 // listDatasets demonstrates iterating through the collection of datasets in a project. 
 func 
  
 listDatasets 
 ( 
 projectID 
  
 string 
 , 
  
 w 
  
 io 
 . 
 Writer 
 ) 
  
 error 
  
 { 
  
 // projectID := "my-project-id" 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 client 
 , 
  
 err 
  
 := 
  
 bigquery 
 . 
 NewClient 
 ( 
 ctx 
 , 
  
 projectID 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 fmt 
 . 
 Errorf 
 ( 
 "bigquery.NewClient: %w" 
 , 
  
 err 
 ) 
  
 } 
  
 defer 
  
 client 
 . 
 Close 
 () 
  
 it 
  
 := 
  
 client 
 . 
  Datasets 
 
 ( 
 ctx 
 ) 
  
 for 
  
 { 
  
 dataset 
 , 
  
 err 
  
 := 
  
 it 
 . 
 Next 
 () 
  
 if 
  
 err 
  
 == 
  
 iterator 
 . 
 Done 
  
 { 
  
 break 
  
 } 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 err 
  
 } 
  
 fmt 
 . 
 Fprintln 
 ( 
 w 
 , 
  
 dataset 
 . 
 DatasetID 
 ) 
  
 } 
  
 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 
. DatasetListOption 
 
 ; 
 import 
  
 com.google.cloud.bigquery. BigQueryException 
 
 ; 
 import 
  
 com.google.cloud.bigquery. BigQueryOptions 
 
 ; 
 import 
  
 com.google.cloud.bigquery. Dataset 
 
 ; 
 public 
  
 class 
 ListDatasets 
  
 { 
  
 public 
  
 static 
  
 void 
  
 main 
 ( 
 String 
 [] 
  
 args 
 ) 
  
 { 
  
 // TODO(developer): Replace these variables before running the sample. 
  
 String 
  
 projectId 
  
 = 
  
 "MY_PROJECT_ID" 
 ; 
  
 listDatasets 
 ( 
 projectId 
 ); 
  
 } 
  
 public 
  
 static 
  
 void 
  
 listDatasets 
 ( 
 String 
  
 projectId 
 ) 
  
 { 
  
 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 
 (); 
  
 Page<Dataset> 
  
 datasets 
  
 = 
  
 bigquery 
 . 
  listDatasets 
 
 ( 
 projectId 
 , 
  
 DatasetListOption 
 . 
 pageSize 
 ( 
 100 
 )); 
  
 if 
  
 ( 
 datasets 
  
 == 
  
 null 
 ) 
  
 { 
  
 System 
 . 
 out 
 . 
 println 
 ( 
 "Dataset does not contain any models" 
 ); 
  
 return 
 ; 
  
 } 
  
 datasets 
  
 . 
 iterateAll 
 () 
  
 . 
 forEach 
 ( 
  
 dataset 
  
 - 
>  
 System 
 . 
 out 
 . 
 printf 
 ( 
 "Success! Dataset ID: %s " 
 , 
  
 dataset 
 . 
 getDatasetId 
 ())); 
  
 } 
  
 catch 
  
 ( 
  BigQueryException 
 
  
 e 
 ) 
  
 { 
  
 System 
 . 
 out 
 . 
 println 
 ( 
 "Project does not contain any datasets \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 
  
 listDatasets 
 () 
  
 { 
  
 /** 
 * TODO(developer): Uncomment the following lines before running the sample. 
 */ 
  
 // const projectId = "my_project_id"; 
  
 // Lists all datasets in the specified project. 
  
 // If projectId is not specified, this method will take 
  
 // the projectId from the authenticated BigQuery Client. 
  
 const 
  
 [ 
 datasets 
 ] 
  
 = 
  
 await 
  
 bigquery 
 . 
  getDatasets 
 
 ({ 
 projectId 
 }); 
  
 console 
 . 
 log 
 ( 
 'Datasets:' 
 ); 
  
 datasets 
 . 
 forEach 
 ( 
 dataset 
  
 = 
>  
 console 
 . 
 log 
 ( 
 dataset 
 . 
 id 
 )); 
 } 
 

PHP

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

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

  use Google\Cloud\BigQuery\BigQueryClient; 
 /** 
 * List all datasets in the given project 
 * 
 * @param string $projectId The project Id of your Google Cloud Project. 
 */ 
 function list_datasets(string $projectId): void 
 { 
 $bigQuery = new BigQueryClient([ 
 'projectId' => $projectId, 
 ]); 
 $datasets = $bigQuery->datasets(); 
 foreach ($datasets as $dataset) { 
 print($dataset->id() . PHP_EOL); 
 } 
 } 
 

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 
 
 () 
 datasets 
 = 
 list 
 ( 
 client 
 . 
  list_datasets 
 
 ()) 
 # Make an API request. 
 project 
 = 
 client 
 . 
 project 
 if 
 datasets 
 : 
 print 
 ( 
 "Datasets in project 
 {} 
 :" 
 . 
 format 
 ( 
 project 
 )) 
 for 
 dataset 
 in 
 datasets 
 : 
 print 
 ( 
 " 
 \t 
 {} 
 " 
 . 
 format 
 ( 
 dataset 
 . 
 dataset_id 
 )) 
 else 
 : 
 print 
 ( 
 " 
 {} 
 project does not contain any datasets." 
 . 
 format 
 ( 
 project 
 )) 
 

Ruby

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

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

  require 
  
 "google/cloud/bigquery" 
 def 
  
 list_datasets 
  
 project_id 
  
 = 
  
 "your-project-id" 
  
 bigquery 
  
 = 
  
 Google 
 :: 
 Cloud 
 :: 
  Bigquery 
 
 . 
  new 
 
  
 project 
 : 
  
 project_id 
  
 puts 
  
 "Datasets in project 
 #{ 
 project_id 
 } 
 :" 
  
 bigquery 
 . 
  datasets 
 
 . 
 each 
  
 do 
  
 | 
 dataset 
 | 
  
 puts 
  
 " 
 \t 
 #{ 
 dataset 
 . 
 dataset_id 
 } 
 " 
  
 end 
 end 
 

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: