vscode-bigquery

A Visual Studio Code (“VS Code”) extension that can query Google Cloud Platform’s BigQuery analytics database from, and return results to, your editor. This extension allows you to:

• Write SQL in VS Code and query BigQuery datasets directly
• Create queries from selected text
• Capture results into VS Code window to manipulate them further

This extension is great if you’re exploring BigQuery and prefer VS Code’s editing environment, or for cases where you’re writing documentation (hint: use “Run selected text as query”) and want to double check that the query is valid.

Installing

The package will be available on the VS Code Marketplace shortly, but in the meantime, you can install it manually:

1. Download the latest pre-built release here: vscode-bigquery-0.0.1.vsix
2. Open the Command Palette in VS Code (Ctrl/Cmd+Shift+P), and type “ext install” -> select “Extension: Install From VSIX…”
3. Navigate to the folder where you saved the .vsix file, and select it.
4. Reload VS Code when prompted.

Usage

The BigQuery extension adds a number of commands to the command palette (Cmd/Ctrl+Shift+P).

By default, it will look for your GOOGLE_APPLICATION_CREDENTIALS environmental variable (if set) and use the service account described in that JSON file. You can also explicitly set bigquery.keyFilename to the path of your Service Account key file. Unless necessary, it’s recommended that you scope this key to the roles.bigquery.user role, which is sufficient for querying and most related tasks.

Optional Configuration

The extension can be customized by modifying your settings.json file. The available configuration options, and their defaults, are below.

"bigquery.keyFilename" = "" // the fully-qualified path to the service account file you downloaded - e.g. '/home/you/mykeyfile-1313ef.json'
"bigquery.projectId" = "" // only needed if your key file is not in JSON format - e.g. 'funny-horse-1234'
"bigquery.email" = "" // only needed if your key file is not in JSON format - e.g. '[email protected]'
"bigquery.useLegacySql" = false // use the legacy SQL language when making queries.
"bigquery.maximumBytesBilled" = null // Unlimited
"bigquery.location" = "US" // Defaults to "US"
"bigquery.outputFormat" = "json" // "json", "csv"

The majority of these settings are inherited from ClientConfig in the underlying BigQuery client library.

Contributing

Feature requests are accepted, but please raise an issue describing your feature before sending a PR. This extension focuses on querying BigQuery, rather than dataset- and/or table- level functionality.

This is not an officially supported Google product.

License

Apache 2.0 licensed. See the LICENSE file for details.