bqls for VSCode
Official VSCode extension for bqls, the BigQuery language server.
Features
- Hover, completion, definition, formatting, and code actions for
.sql / .bq files, powered by bqls.
- View query results and table/job information through the
bqls:// virtual document scheme.
- Running "Execute Query" or picking a job from "List Job Histories" opens the result automatically; "Save Result to Spreadsheet" opens the created sheet in your browser.
Requirements
On macOS and Linux, the extension downloads a matching bqls release from
GitHub automatically the first time it activates (cached under the
extension's global storage), so no manual install is required. If bqls is
already on your PATH (e.g. via go install), that one is used instead.
Windows is not yet supported by the automatic download. Install bqls
manually and point bqls.path at it:
go install github.com/kitagry/bqls@latest
You also need to authenticate with Google Cloud:
gcloud auth login
gcloud auth application-default login
Settings
| Setting |
Description |
Default |
bqls.path |
Path to the bqls executable. |
bqls |
bqls.projectId |
BigQuery project ID. If empty, bqls falls back to gcloud config get project. |
"" |
bqls.location |
BigQuery location (e.g. US, asia-northeast1). If empty, bqls uses US. |
"" |
bqls.trace.server |
Trace communication between VSCode and the language server. |
off |
Development
npm install
npm run watch # rebuild on change
npm run test # run unit tests
npm run lint
Press F5 in VSCode (opened at editors/vscode) to launch an Extension Development Host.