https://github.com/surrealdb/surrealql-grammar

SurrealQL grammar definition for TextMate, VSCode, and other IDEs
https://github.com/surrealdb/surrealql-grammar

surreal surrealdb surrealdb-grammar surrealql surrealql-grammar textmate textmate-grammar textmate-language

Last synced: 3 months ago
JSON representation

SurrealQL grammar definition for TextMate, VSCode, and other IDEs

• Host: GitHub
• URL: https://github.com/surrealdb/surrealql-grammar
• Owner: surrealdb
• License: apache-2.0
• Created: 2023-05-22T11:29:32.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2025-06-06T00:14:37.000Z (4 months ago)
• Last Synced: 2025-07-17T21:28:00.193Z (3 months ago)
• Topics: surreal, surrealdb, surrealdb-grammar, surrealql, surrealql-grammar, textmate, textmate-grammar, textmate-language
• Homepage: https://surrealdb.com
• Size: 253 KB
• Stars: 31
• Watchers: 14
• Forks: 7
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# SurrealQL grammar

SurrealQL is the SQL-like language used by [SurrealDB](https://surrealdb.com). This repository holds it's grammar definition, implementing the textmate-grammar specification.

## Getting started

The grammar is mainly written for the [Visual Studio Code](https://code.visualstudio.com/) editor. It is easiest to change the grammar there and to debug it. 

To get started:

- Clone this repository (https://github.com/surrealdb/surrealql-grammar)

- Open the cloned folder in VScode

- Open the debug panel from the left sidebar

- In the middle top of the opened pane, open the (green) start button

- A new window should pop up. Open a SurrealQL file to edit it and see the grammar in action.

## Credits

This grammar was much inspired by [Mathe42](https://github.com/mathe42)'s work. You can find his work [here on GitHub](https://github.com/surrealdb-community/surrealql_vscode).