https://github.com/mitranim/sublime-sql

Sublime Text syntax definitions for SQL, rebuilt with better semantics. Currently only Postgres dialect.
https://github.com/mitranim/sublime-sql

Last synced: 5 months ago
JSON representation

Sublime Text syntax definitions for SQL, rebuilt with better semantics. Currently only Postgres dialect.

• Host: GitHub
• URL: https://github.com/mitranim/sublime-sql
• Owner: mitranim
• License: unlicense
• Created: 2021-01-18T08:51:02.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2022-11-30T14:40:37.000Z (over 3 years ago)
• Last Synced: 2025-10-11T14:55:35.336Z (9 months ago)
• Homepage:
• Size: 87.9 KB
• Stars: 5
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

          
## Overview

Sublime Text syntax for Postgres SQL. Written in [SBNF](https://github.com/BenjaminSchaaf/sbnf):

  * Source file: `pgsql.sbnf`.

  * Auto-generated syntax: `pgsql.sublime-syntax`.

Differences from built-in "SQL" and Package Control packages "PgSQL" and "PostgreSQL Syntax Highlighting":

* Contextual types.

  * Types are scoped _only_ where expected.

  * No whitelist of built-ins.

  * No difference between pre-defined and user-defined types.

* Conservative use of keywords.

  * Only reserved keywords and extremely common keywords are context-free.

  * Other keywords are contextual, where expected.

* No unnecessary scopes for built-in functions or types.

* Prefers to scope keywords as `keyword` rather than `storage`.

* Adheres more closely to ST scope conventions while respecting SQL semantics.

* Supports ordinal parameters like `$1` and named parameters like `:ident`.

Current limitations:

* Only the Postgres dialect is implemented.

* Doesn't implement some non-reserved but common keywords such as `update` or `delete`.

* Doesn't implement some contextual keywords such as `on update cascade`.

* NYI: PL/PGSQL.

* NYI: multi-word types.

* NYI: function calls.

* ... Probably a few more NYI.

Despite the limitations, I consider this much more usable than the previously-mentioned packages.

## Installation

Clone the repo and symlink it to your Sublime packages directory. Example for MacOS:

```sh

git clone https://github.com/mitranim/sublime-sql.git

cd sublime-sql

ln -sf "$(pwd)" "$HOME/Library/Application Support/Sublime Text 3/Packages/"

```

To find the packages directory on your system, use Sublime Text menu → Preferences → Browse Packages.

## TODO

(Because I'll forget otherwise.)

* More contextual keywords.

* PL/PGSQL.

* Better support for types.

* A million other Postgres-specific things.

## License

https://unlicense.org

## Misc

I'm receptive to suggestions. If this package _almost_ satisfies you but needs changes, open an issue or chat me up. Contacts: https://mitranim.com/#contacts