Databases
Big Query
Execute queries to Big Query with the bq command line tool.
Prerequisites
To get the most out of this guide, you will need to:
- Either create an account in our managed instance or deploy your own hoop.dev instance
- You must be your account administrator to perform the following commands
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.
Feature | Native | One Off | Description |
---|---|---|---|
TLS Termination Proxy | The local proxy terminates the connection with TLS, enabling the connection with the remote server to be TLS encrypted. | ||
Audit | The 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 Offload | The user authenticates via SSO instead of using database credentials. | ||
Interactive Access | Interactive access is available when using an IDE or connecting via a terminal to perform analysis exploration. |
Configuration
Name | Type | Required | Description |
---|---|---|---|
GOOGLE_APPLICATION_CREDENTIALS | filesystem | yes | The service account credentials file in JSON format |
CLOUDSDK_CORE_PROJECT | envvar | yes | The project id to use for request |
CLOUDSDK_PYTHON | envvar | no | The 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.
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.