​
Prerequisites

To get the most out of this guide, you will need to:

​
Features

The table below outlines the features available for this type of connection.
  • Native - This refers to when a database client connects through a specific protocol, such as an IDE or client libraries through hoop connect <connection-name>.
  • One Off - This term refers to accessing this connection from hoop web panel.
FeatureNativeOne OffDescription
TLS Termination Proxy The local proxy terminates the connection with TLS, enabling the connection with the remote server to be TLS encrypted.
AuditThe gateway store and audit the queries being issued by the client
Data Masking (Google DLP)A policy can be enabled to mask sensitive fields dynamically when performing queries in the database.
Data Masking (MS Presidio)A policy can be enabled to mask sensitive fields dynamically when performing queries in the database.
Credentials OffloadThe user authenticates via SSO instead of using database credentials.
Interactive AccessInteractive access is available when using an IDE or connecting via a terminal to perform analysis exploration.

​
Configuration

NameTypeRequiredDescription
GOOGLE_APPLICATION_CREDENTIALSfilesystemyesThe service account credentials file in JSON format
CLOUDSDK_CORE_PROJECTenvvaryesThe project id to use for request
CLOUDSDK_PYTHONenvvarnoThe path of python interpreter, defaults to /usr/bin/python3.9
The Google Service Account Credentials must have the following permissions:
  • BigQuery User
  • BigQuery Data Viewer

​
Connection Setup

The command below provides access to bq query command, enabling you to execute queries directly against BigQuery datasets. For additional examples and advanced connection options, refer to the BigQuery Command-Line Reference documentation. 
hoop admin create conn bq-query -a <agent> \
    -e filesystem:GOOGLE_APPLICATION_CREDENTIALS=file:///path/to/google-service-account.json \
    -e CLOUDSDK_CORE_PROJECT=<project-id-name> \
    -- bq query --use_legacy_sql=false
The bq command-line tool is included in agent Docker images version 1.35.16 and later.

​
Connection Usage

You can access it through hoop web panel and issue queries to your Datasets.