RunQL BigQuery Connector
Optional BigQuery connector for the RunQL VS Code extension. Install alongside RunQL to query BigQuery projects with RunQL's SQL workflows, results panel, schema introspection, and ERD tooling.
This extension is maintained separately so users who do not need BigQuery are not required to install Google Cloud driver dependencies.
Installation
- Install RunQL (required, declared as an extension dependency).
- Install RunQL BigQuery Connector from the VS Code Marketplace.
RunQL will detect the connector on activation and register BigQuery as an available connection provider.
Usage
- Open the RunQL explorer view.
- Click Add Connection and choose BigQuery.
- Enter the Google Cloud project ID.
- Optionally enter a default dataset and query job location.
- Choose Application Default Credentials, a service-account key file, or pasted service-account JSON.
- Save and test the connection.
Requirements
- VS Code
^1.96.0
- RunQL extension
- A Google Cloud project with BigQuery enabled
- Credentials with permissions to run jobs and read the datasets you want to inspect
Authentication
The connector supports:
- Application Default Credentials
- Service-account key file authentication
- Pasted service-account JSON stored in VS Code secret storage
How it works
On activation, this extension acquires the RunQL extension API and calls:
registerProvider(bigqueryProvider) to add BigQuery to the connection form.registerAdapter('bigquery', () => new BigQueryAdapter()) to wire the dialect to its implementation.
The adapter uses the @google-cloud/bigquery Node package. Schema introspection enumerates visible datasets through the BigQuery API, reads table metadata for columns and constraints, and uses dataset-level INFORMATION_SCHEMA queries for routines where permissions allow.
Building from source
git clone https://github.com/DVCodeLabs/RunQL-BigQuery.git
cd RunQL-BigQuery
npm install
npm run package
To produce a local VSIX for testing:
npm install -g @vscode/vsce
vsce package
License
MIT, see LICENSE.
