sqlsurge

sqlsurge is a Visual Studio Code extension for SQL language server using sqls. It works just NOT ONLY with SQL files, but also with RAW SQL QUERIES on other languages such as TypeScript and Rust.

Prisma Example in TypeScript:

SQLx Example in Rust:

Requirements

• Golang v1.22.2 or later
• sqls v0.2.28 or later
  • There is sqls installation guide in the extension.

Supported RDBMS

See: https://github.com/sqls-server/sqls?tab=readme-ov-file#support-rdbms

Features

• Completion
• Formatting
• Quick Info Symbol
• Any Raw SQL Queries Support (Experimental)

This table shows the features available for each file extension.

Completion

These are the completion items sqlsurge provides:

• SQL keywords
• Tables and columns (Required to be configured by sqls config)

About raw SQL queries, VSCode's quick suggestion(auto completion) in strings is disabled by default. It can be enabled by adding the following setting to settings.json.

"editor.quickSuggestions": {
    "strings": true
}

Formatting

SQL File

• VSCode Command: Format Document
• Formatter: sqls

Embedded Files (TypeScript, Rust, etc.)

• VSCode Command: sqlsurge: Format SQL
• Formatter: SQL Formatter

For embedded SQL queries, there are several VS Code configurations available.

• sqlsurge.formatOnSave: Format SQL on save. Default is true.
• sqlsurge.formatSql.indent: Format SQL with indent. Default is false.

Also, sqlsurge reads the .sql-formatter.json file if it exists in the workspace root. If not, it uses the default SQL Formatter configuration.

Quick Info Symbol

Quick info symbol for tables and columns can be shown by triggering completion with Ctrl + Space or Cmd + Space.

Any Raw SQL Queries Support (Experimental)

[!NOTE] This feature is experimental. Feedback is welcome!

sqlsurge supports Prisma in TypeScript and SQLx in Rust by default. But you can use sqlsurge with any raw SQL queries, such as TypeORM or user-defined functions by setting.

This is an example of settings for custom raw SQL queries.

// TypeORM in TypeScript
const someQuery = await entityManager.query(
  "SELECT * FROM todos WHERE id = $1;",
  [1]
);

"sqlsurge.customRawSqlQuery": {
  "language": "typescript",
  "configs": [
    {
      "functionName": "query",
      "sqlArgNo": 1,
      "isTemplateLiteral": false
    }
  ]
}

VS Code Commands

• sqlsurge: Install sqls: Install sqls.
• sqlsurge: Restart SQL Language Server: Restart SQL Language Server.
  • This command is useful when you update sqls or change the configuration.
• sqlsurge: Format SQL: Format Raw SQL query.
• Format Document: Format SQL file with sqls.

TODOs

• [x] Support for Prisma in TypeScript
• [x] Support for SQLx in Rust
• [x] Install guide for sqls
• [x] Format SQL (Vanilla SQL: sqls, Raw SQL: SQL Formatter)
• [x] Show quick info symbol
• [x] Support to custom raw SQL queries, not just Prisma and SQLx
• [ ] Execute SQL query
• [ ] Show sqls config with tree view