https://github.com/harshdoesdev/rayql
RayQL is a schema definition and query language for SQLite
https://github.com/harshdoesdev/rayql
dsl query-dsl query-language schema sqlite
Last synced: 4 months ago
JSON representation
RayQL is a schema definition and query language for SQLite
- Host: GitHub
- URL: https://github.com/harshdoesdev/rayql
- Owner: harshdoesdev
- License: mit
- Created: 2024-03-07T15:35:07.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-05T15:48:57.000Z (6 months ago)
- Last Synced: 2025-01-05T16:33:31.749Z (6 months ago)
- Topics: dsl, query-dsl, query-language, schema, sqlite
- Language: Rust
- Homepage: https://rayql.com
- Size: 258 KB
- Stars: 51
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# RayQL
RayQL is a schema definition and query language for SQLite.
[Join our Discord Channel](https://discord.gg/4re5ShTshg)
## Online Editor
You can try RayQL using the [Online RayQL editor](https://harshdoesdev.github.io/rayql-studio/).
## Installation
You can install RayQL by running the following command in your terminal:
```bash
curl -s https://rayql.com/install.sh | sh
```
## Schema Definition
You can define your database schema by creating a RayQL file called `schema.rayql`.
For example, it might look something like this:
```rayql
# Enum for user types
enum user_type {
admin
developer
normal
}
# Model declaration for 'user'
model user {
id: int primary_key auto_increment,
username: str unique,
email: str unique, # this is an inline comment
phone_number: str?,
user_type: user_type default(user_type.normal)
}
# Model declaration for 'post'
model post {
id: int primary_key auto_increment,
title: str default('New Post'),
content: str,
author_id: int foreign_key(user.id),
created_at: timestamp default(now()),
}
```
Then, when you run the `rayql print` command, it will generate and output the SQL equivalent of that model, which for the above example should look something like this:
```sql
CREATE TABLE IF NOT EXISTS user (
id INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT,
username TEXT NOT NULL UNIQUE,
email TEXT NOT NULL UNIQUE,
phone_number TEXT NULL,
user_type TEXT NOT NULL CHECK(user_type IN ('admin', 'developer', 'normal')) DEFAULT 'normal'
);
CREATE TABLE IF NOT EXISTS post (
id INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT,
title TEXT NOT NULL DEFAULT 'New Post',
content TEXT NOT NULL,
author_id INTEGER NOT NULL,
created_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
FOREIGN KEY (author_id) REFERENCES user(id)
);
```
## Todo
- [x] Basic Schema Parser
- [x] `rayql print` command
- [ ] Database commands
- [ ] `rayql db push` and `rayql db pull` commands
- [ ] `rayql db migrate` command
- [ ] Typescript Types generator
- [ ] Query Parser and Handler