Get connection metadata

Retrieves connection metadata about a specified BigQuery connection. Credential secrets are not returned.

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 
' 
 ). 
 v1 
 ; 
 const 
  
 { 
 status 
 } 
  
 = 
  
 require 
 ( 
 '@grpc/grpc-js' 
 ); 
 const 
  
 client 
  
 = 
  
 new 
  
  ConnectionServiceClient 
 
 (); 
 /** 
 * Retrieves connection metadata about a specified BigQuery connection. 
 * 
 * A connection stores metadata about an external data source and credentials to access it. 
 * 
 * @param {string} projectId - Google Cloud project ID. for example, 'example-project-id' 
 * @param {string} location - The location of the connection. for example, 'us-central1' 
 * @param {string} connectionId - The ID of the connection to retrieve. for example, 'example_connection' 
 */ 
 async 
  
 function 
  
 getConnection 
 ( 
 projectId 
 , 
  
 location 
 , 
  
 connectionId 
 ) 
  
 { 
  
 const 
  
 name 
  
 = 
  
 client 
 . 
 connectionPath 
 ( 
 projectId 
 , 
  
 location 
 , 
  
 connectionId 
 ); 
  
 const 
  
 request 
  
 = 
  
 { 
  
 name 
 , 
  
 }; 
  
 try 
  
 { 
  
 const 
  
 [ 
 connection 
 ] 
  
 = 
  
 await 
  
 client 
 . 
 getConnection 
 ( 
 request 
 ); 
  
 console 
 . 
 log 
 ( 
 `Successfully retrieved connection: 
 ${ 
 connection 
 . 
 name 
 } 
 ` 
 ); 
  
 console 
 . 
 log 
 ( 
 `  Friendly name: 
 ${ 
 connection 
 . 
 friendlyName 
 } 
 ` 
 ); 
  
 console 
 . 
 log 
 ( 
 `  Description: 
 ${ 
 connection 
 . 
 description 
 } 
 ` 
 ); 
  
 console 
 . 
 log 
 ( 
 `  Has credential: 
 ${ 
 connection 
 . 
 hasCredential 
 } 
 ` 
 ); 
  
 if 
  
 ( 
 connection 
 . 
 cloudSql 
 ) 
  
 { 
  
 console 
 . 
 log 
 ( 
 `  Cloud SQL instance ID: 
 ${ 
 connection 
 . 
 cloudSql 
 . 
 instanceId 
 } 
 ` 
 ); 
  
 console 
 . 
 log 
 ( 
 `  Cloud SQL database: 
 ${ 
 connection 
 . 
 cloudSql 
 . 
 database 
 } 
 ` 
 ); 
  
 console 
 . 
 log 
 ( 
 `  Cloud SQL type: 
 ${ 
 connection 
 . 
 cloudSql 
 . 
 type 
 } 
 ` 
 ); 
  
 } 
  
 } 
  
 catch 
  
 ( 
 err 
 ) 
  
 { 
  
 if 
  
 ( 
 err 
 . 
 code 
  
 === 
  
 status 
 . 
 NOT_FOUND 
 ) 
  
 { 
  
 console 
 . 
 log 
 ( 
 `Connection 
 ${ 
 name 
 } 
 not found.` 
 ); 
  
 } 
  
 else 
  
 { 
  
 console 
 . 
 error 
 ( 
 `Error getting connection 
 ${ 
 name 
 } 
 :` 
 , 
  
 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 
 
 client 
 = 
  bigquery_connection_v1 
 
 . 
  ConnectionServiceClient 
 
 () 
 def 
  
 get_connection 
 ( 
 project_id 
 : 
 str 
 , 
 location 
 : 
 str 
 , 
 connection_id 
 : 
 str 
 ): 
  
 """Retrieves connection metadata about a specified BigQuery connection. 
 A connection stores metadata about an external data source and credentials to access it. 
 Args: 
 project_id: The Google Cloud project ID. 
 location: The geographic location of the connection (for example, "us-central1"). 
 connection_id: The ID of the connection to retrieve. 
 """ 
 name 
 = 
 client 
 . 
  connection_path 
 
 ( 
 project_id 
 , 
 location 
 , 
 connection_id 
 ) 
 try 
 : 
 connection 
 = 
 client 
 . 
  get_connection 
 
 ( 
 name 
 = 
 name 
 ) 
 print 
 ( 
 f 
 "Successfully retrieved connection: 
 { 
 connection 
 . 
 name 
 } 
 " 
 ) 
 print 
 ( 
 f 
 "Friendly name: 
 { 
 connection 
 . 
 friendly_name 
 } 
 " 
 ) 
 print 
 ( 
 f 
 "Description: 
 { 
 connection 
 . 
 description 
 } 
 " 
 ) 
 if 
 connection 
 . 
 cloud_sql 
 : 
 print 
 ( 
 f 
 "Cloud SQL instance ID: 
 { 
 connection 
 . 
 cloud_sql 
 . 
 instance_id 
 } 
 " 
 ) 
 except 
 google 
 . 
 api_core 
 . 
 exceptions 
 . 
 NotFound 
 : 
 print 
 ( 
 f 
 "Connection ' 
 { 
 name 
 } 
 ' not found." 
 ) 
 

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: