Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/senkenn/sqlsurge
Visual Studio Code extension for SQL language server
https://github.com/senkenn/sqlsurge
rust sql typescript vscode-extension
Last synced: 2 days ago
JSON representation
Visual Studio Code extension for SQL language server
- Host: GitHub
- URL: https://github.com/senkenn/sqlsurge
- Owner: senkenn
- License: mit
- Created: 2024-03-04T22:14:30.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2025-02-01T12:07:31.000Z (19 days ago)
- Last Synced: 2025-02-01T12:26:18.574Z (19 days ago)
- Topics: rust, sql, typescript, vscode-extension
- Language: TypeScript
- Homepage: https://marketplace.visualstudio.com/items?itemName=senken.sqlsurge
- Size: 1.54 MB
- Stars: 41
- Watchers: 1
- Forks: 0
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# sqlsurge
[sqlsurge](https://marketplace.visualstudio.com/items?itemName=senken.sqlsurge) is a Visual Studio Code extension for SQL language server using [sqls](https://github.com/lighttiger2505/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**](https://golang.org/doc/install) v1.22.2 or later
- [**sqls**](https://github.com/sqls-server/sqls?tab=readme-ov-file#installation) 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](#completion)
- [Formatting](#formatting)
- [Quick Info Symbol](#quick-info-symbol)
- [Any Raw SQL Queries Support (Experimental)](#any-raw-sql-queries-support-experimental)
This table shows the features available for each file extension.
| Features | `.sql` | `.ts` | `.rs` |
| ------------------------------- | ------ | ----- | ----- |
| Completion | ✅ | ✅ | ✅ |
| Formatting | ✅ | ✅ | ✅ |
| Quick Info Symbol on Completion | ✅ | ✅ | ✅ |
| Quick Info Symbol on Hover | ✅ | ❌ | ❌ |
| Any Raw SQL Queries Support | ー | ✅ | ✅ |
### 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.
```json
"editor.quickSuggestions": {
"strings": true
}
```
### Formatting
#### SQL File
- VSCode Command: `Format Document`
- Formatter: sqls
#### Embedded SQL in Other Files (TypeScript, Rust, etc.)
- VSCode Command: `sqlsurge: Format SQL`
- Formatter: [SQL Formatter](https://github.com/sql-formatter-org/sql-formatter)
For embedded SQL code in other files, 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.
```ts
// TypeORM in TypeScript
const someQuery = await entityManager.query(
"SELECT * FROM todos WHERE id = $1;",
[1]
);
```
```json
"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](https://github.com/sql-formatter-org/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