bqls for Visual Studio Code

VSCode extension for bqls: BigQuery Language Server

Features

Execute query

Command Palette (Ctrl+Shift+P) -> bqls: Execute Query

or

Code Action (Ctrl+.) -> Execute Query

Save result

local CSV or Google Spreadsheet

Table Explorer

Hover infomation

Column

Function

etc.

• Format
• Definition jump
• Auto Complete

Install

prerequisite: install bqls

download from https://github.com/kitagry/bqls/releases/tag/v0.4.0 and place it into PATH

or else, build from source

CC=clang CXX=clang++ go install github.com/kitagry/bqls@v0.4.0

check

bqls -version

prerequisite: install gcloud SDK

https://cloud.google.com/sdk/docs/install

gcloud auth application-default login

install extension

git clone https://github.com/yokomotod/bqls-vscode.git
cd bqls-vscode

npm install
npx vsce package

code --install-extension bqls-vscode-0.1.0.vsix

bqls support status

• ✅ textDocument/formatting
  • format SQL by zetasql.FormatSQL
• ✅ textDocument/hover
  • show table/column metadata
  • show function document
• ✅ textDocument/definition
  • show table information
• 🔺 textDocument/codeAction
  • ✅ bqls.executeQuery
  • ❌ bqls.listJobHistories
• workspace/executeCommand
  • ✅ bqls.executeQuery
  • ✅ bqls.listDatasets
  • ✅ bqls.listTables
  • ❌ bqls.listJobHistories
  • ✅ bqls.saveResult
    • save query result to csv
    • save query result to google spreadsheet
• ❌ workspace/didChangeConfiguration

based on https://github.com/kitagry/bqls/tree/main#supported-protocol