List connections

Lists all BigQuery connections defined in a specific Google Cloud project and location.

Code sample

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 .

  const 
  
 { 
 ConnectionServiceClient 
 } 
  
 = 
  
 require 
 ( 
 ' @google-cloud/bigquery-connection 
' 
 ); 
 const 
  
 { 
 status 
 } 
  
 = 
  
 require 
 ( 
 '@grpc/grpc-js' 
 ); 
 const 
  
 client 
  
 = 
  
 new 
  
  ConnectionServiceClient 
 
 (); 
 /** 
 * Lists BigQuery connections in a given project and location. 
 * 
 * @param {string} projectId The Google Cloud project ID. for example, 'example-project-id' 
 * @param {string} location The location to list connections for. for example, 'us-central1' 
 */ 
 async 
  
 function 
  
 listConnections 
 ( 
 projectId 
 , 
  
 location 
 ) 
  
 { 
  
 const 
  
 parent 
  
 = 
  
 client 
 . 
 locationPath 
 ( 
 projectId 
 , 
  
 location 
 ); 
  
 const 
  
 request 
  
 = 
  
 { 
  
 parent 
 , 
  
 pageSize 
 : 
  
 100 
 , 
  
 }; 
  
 try 
  
 { 
  
 const 
  
 [ 
 connections 
 ] 
  
 = 
  
 await 
  
 client 
 . 
 listConnections 
 ( 
 request 
 , 
  
 { 
  
 autoPaginate 
 : 
  
 false 
 , 
  
 }); 
  
 if 
  
 ( 
 connections 
 . 
 length 
  
 === 
  
 0 
 ) 
  
 { 
  
 console 
 . 
 log 
 ( 
  
 `No connections found in 
 ${ 
 location 
 } 
 for project 
 ${ 
 projectId 
 } 
 .` 
 , 
  
 ); 
  
 return 
 ; 
  
 } 
  
 console 
 . 
 log 
 ( 
 'Connections:' 
 ); 
  
 for 
  
 ( 
 const 
  
 connection 
  
 of 
  
 connections 
 ) 
  
 { 
  
 console 
 . 
 log 
 ( 
 `  Name: 
 ${ 
 connection 
 . 
 name 
 } 
 ` 
 ); 
  
 console 
 . 
 log 
 ( 
 `  Friendly Name: 
 ${ 
 connection 
 . 
 friendlyName 
 } 
 ` 
 ); 
  
 } 
  
 } 
  
 catch 
  
 ( 
 err 
 ) 
  
 { 
  
 if 
  
 ( 
 err 
 . 
 code 
  
 === 
  
 status 
 . 
 NOT_FOUND 
 ) 
  
 { 
  
 console 
 . 
 log 
 ( 
  
 `Project ' 
 ${ 
 projectId 
 } 
 ' or location ' 
 ${ 
 location 
 } 
 ' not found.` 
 , 
  
 ); 
  
 } 
  
 else 
  
 { 
  
 console 
 . 
 error 
 ( 
 'Error listing connections:' 
 , 
  
 err 
 ); 
  
 } 
  
 } 
 } 
 

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 .

  import 
  
 google.api_core.exceptions 
 from 
  
 google.cloud 
  
 import 
  bigquery_connection_v1 
 
 def 
  
 list_connections 
 ( 
 project_id 
 : 
 str 
 , 
 location 
 : 
 str 
 ): 
  
 """Prints all connections in a given project and location. 
 Args: 
 project_id: The Google Cloud project ID. 
 location: The geographic location of the connections (for example, "us", "us-central1"). 
 """ 
 client 
 = 
  bigquery_connection_v1 
 
 . 
  ConnectionServiceClient 
 
 () 
 parent 
 = 
 client 
 . 
  common_location_path 
 
 ( 
 project_id 
 , 
 location 
 ) 
 request 
 = 
  bigquery_connection_v1 
 
 . 
  ListConnectionsRequest 
 
 ( 
 parent 
 = 
 parent 
 , 
 page_size 
 = 
 100 
 , 
 ) 
 print 
 ( 
 f 
 "Listing connections in project ' 
 { 
 project_id 
 } 
 ' and location ' 
 { 
 location 
 } 
 ':" 
 ) 
 try 
 : 
 for 
 connection 
 in 
 client 
 . 
  list_connections 
 
 ( 
 request 
 = 
 request 
 ): 
 print 
 ( 
 f 
 "Connection ID: 
 { 
 connection 
 . 
 name 
 . 
 split 
 ( 
 '/' 
 )[ 
 - 
 1 
 ] 
 } 
 " 
 ) 
 print 
 ( 
 f 
 "Friendly Name: 
 { 
 connection 
 . 
 friendly_name 
 } 
 " 
 ) 
 print 
 ( 
 f 
 "Has Credential: 
 { 
 connection 
 . 
 has_credential 
 } 
 " 
 ) 
 print 
 ( 
 "-" 
 * 
 20 
 ) 
 print 
 ( 
 "Finished listing connections." 
 ) 
 except 
 google 
 . 
 api_core 
 . 
 exceptions 
 . 
 InvalidArgument 
 as 
 e 
 : 
 print 
 ( 
 f 
 "Could not list connections. Please check that the project ID ' 
 { 
 project_id 
 } 
 ' " 
 f 
 "and location ' 
 { 
 location 
 } 
 ' are correct. Details: 
 { 
 e 
 } 
 " 
 ) 
 

What's next

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

Create a Mobile Website
View Site in Mobile | Classic
Share by: