List models

Lists all existing models in a dataset.

Explore further

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

List models

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" 
 ) 
 // listModels demonstrates iterating through the collection of ML models in a dataset 
 // and printing a basic identifier of the model. 
 func 
  
 listModels 
 ( 
 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 
 () 
  
 fmt 
 . 
 Fprintf 
 ( 
 w 
 , 
  
 "Models contained in dataset %q\n" 
 , 
  
 datasetID 
 ) 
  
 it 
  
 := 
  
 client 
 . 
 Dataset 
 ( 
 datasetID 
 ). 
  Models 
 
 ( 
 ctx 
 ) 
  
 for 
  
 { 
  
 m 
 , 
  
 err 
  
 := 
  
 it 
 . 
 Next 
 () 
  
 if 
  
 err 
  
 == 
  
 iterator 
 . 
 Done 
  
 { 
  
 break 
  
 } 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 err 
  
 } 
  
 fmt 
 . 
 Fprintf 
 ( 
 w 
 , 
  
 "Model: %s\n" 
 , 
  
 m 
 . 
 FullyQualifiedName 
 ()) 
  
 } 
  
 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 
. ModelListOption 
 
 ; 
 import 
  
 com.google.cloud.bigquery. BigQueryException 
 
 ; 
 import 
  
 com.google.cloud.bigquery. BigQueryOptions 
 
 ; 
 import 
  
 com.google.cloud.bigquery. Model 
 
 ; 
 public 
  
 class 
 ListModels 
  
 { 
  
 public 
  
 static 
  
 void 
  
 main 
 ( 
 String 
 [] 
  
 args 
 ) 
  
 { 
  
 // TODO(developer): Replace these variables before running the sample. 
  
 String 
  
 datasetName 
  
 = 
  
 "MY_DATASET_NAME" 
 ; 
  
 listModels 
 ( 
 datasetName 
 ); 
  
 } 
  
 public 
  
 static 
  
 void 
  
 listModels 
 ( 
 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 
 (); 
  
 Page<Model> 
  
 models 
  
 = 
  
 bigquery 
 . 
  listModels 
 
 ( 
 datasetName 
 , 
  
 ModelListOption 
 . 
 pageSize 
 ( 
 100 
 )); 
  
 if 
  
 ( 
 models 
  
 == 
  
 null 
 ) 
  
 { 
  
 System 
 . 
 out 
 . 
 println 
 ( 
 "Dataset does not contain any models." 
 ); 
  
 return 
 ; 
  
 } 
  
 models 
  
 . 
 iterateAll 
 () 
  
 . 
 forEach 
 ( 
 model 
  
 - 
>  
 System 
 . 
 out 
 . 
 printf 
 ( 
 "Success! Model ID: %s" 
 , 
  
 model 
 . 
  getModelId 
 
 ())); 
  
 } 
  
 catch 
  
 ( 
  BigQueryException 
 
  
 e 
 ) 
  
 { 
  
 System 
 . 
 out 
 . 
 println 
 ( 
 "Models not listed in dataset due to error: \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 
  
 listModels 
 () 
  
 { 
  
 // Lists all existing models in the dataset. 
  
 /** 
 * TODO(developer): Uncomment the following lines before running the sample. 
 */ 
  
 // const datasetId = "my_dataset"; 
  
 const 
  
 dataset 
  
 = 
  
 bigquery 
 . 
 dataset 
 ( 
 datasetId 
 ); 
  
 dataset 
 . 
  getModels 
 
 (). 
 then 
 ( 
 data 
  
 = 
>  
 { 
  
 const 
  
 models 
  
 = 
  
 data 
 [ 
 0 
 ]; 
  
 console 
 . 
 log 
 ( 
 'Models:' 
 ); 
  
 models 
 . 
 forEach 
 ( 
 model 
  
 = 
>  
 console 
 . 
 log 
 ( 
 model 
 . 
 metadata 
 )); 
  
 }); 
 }

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 that contains 
 #                  the models you are listing. 
 # dataset_id = 'your-project.your_dataset' 
 models 
 = 
 client 
 . 
  list_models 
 
 ( 
 dataset_id 
 ) 
 # Make an API request. 
 print 
 ( 
 "Models contained in ' 
 {} 
 ':" 
 . 
 format 
 ( 
 dataset_id 
 )) 
 for 
 model 
 in 
 models 
 : 
 full_model_id 
 = 
 " 
 {} 
 . 
 {} 
 . 
 {} 
 " 
 . 
 format 
 ( 
 model 
 . 
 project 
 , 
 model 
 . 
 dataset_id 
 , 
 model 
 . 
 model_id 
 ) 
 friendly_name 
 = 
 model 
 . 
 friendly_name 
 print 
 ( 
 " 
 {} 
 : friendly_name=' 
 {} 
 '" 
 . 
 format 
 ( 
 full_model_id 
 , 
 friendly_name 
 ))

What's next

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

List models Stay organized with collections Save and categorize content based on your preferences.

Explore further

Code sample

Go

Java

Node.js

Python

What's next

List models