Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lmoors30/sqly
A lightweight macro system on top of sqlx, inspired by ormx.
https://github.com/lmoors30/sqly
async await postgres rust sql
Last synced: 3 days ago
JSON representation
A lightweight macro system on top of sqlx, inspired by ormx.
- Host: GitHub
- URL: https://github.com/lmoors30/sqly
- Owner: LMOORS30
- License: apache-2.0
- Created: 2024-08-28T12:38:59.000Z (about 1 month ago)
- Default Branch: master
- Last Pushed: 2024-09-05T13:05:54.000Z (28 days ago)
- Last Synced: 2024-09-30T10:22:06.756Z (3 days ago)
- Topics: async, await, postgres, rust, sql
- Language: Rust
- Homepage:
- Size: 43.9 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
sqly
[
](https://github.com/LMOORS30/sqly)
[
](https://crates.io/crates/sqly)
[
](https://docs.rs/sqly)
====
sqly is a lightweight macro system on top of [sqlx](https://github.com/launchbadge/sqlx), inspired by [ormx](https://github.com/NyxCode/ormx).
It works by generating common SQL queries and associated structs at compile time, letting the generated queries be checked and executed by sqlx.
This crate differs from ormx mainly by the added functionality of generating SQL `SELECT` queries with support for nested objects through SQL `JOIN` clauses. Additionally, `sqly::query!` macros can be used to further expand generated queries while still providing compile-time verification.
This functionality is still under development (see [Roadmap](#roadmap)).
##### Cargo.toml
```toml
[dependencies.sqly]
version = "0.2.0"
features = ["postgres"]
[dependencies.sqlx]
version = "0.8.0"
default-features = false
features = ["macros", "postgres"]
[profile.dev.package.sqlx-macros]
opt-level = 3
[profile.dev.package.sqly-macros]
opt-level = 3
```
##### Features
`unchecked` — disable compile-time checking
` postgres` — generate queries for PostgreSQL
` sqlite` — generate queries for SQLite (not supported)
` mysql` — generate queries for MySQL (not supported)
Currently only postgres is supported.
### Usage
[](https://docs.rs/sqly)
### Roadmap
- [x] Basic `DELETE` queries
- [x] Basic `INSERT` queries
- [x] Basic `UPDATE` queries
- [X] Storing information across separate `#[derive]` invocations
- [X] Basic `SELECT` queries
- [ ] `sqly::query!` macros to extend generated queries
- [ ] `#[sqly(alias)]` attribute and optional override in macros
- [ ] `#[sqly(default, from, try_from, flatten)]` attributes for select
- [ ] `#[sqly(optional)]` attribute for optional update and insert fields
- [ ] `#[sqly(returning)]` attribute for generating SQL `RETURNING` clauses
- [ ] `#[sqly(foreign)]` attributes for nested objects through SQL `JOIN` clauses
- [ ] Support for decoding database rows unchecked or by index
- [ ] Implementation of bulk operations for `&[T]`
- [ ] Support for SQL `DISTINCT` clause in select
- [ ] Support for including constants in the SQL
- [ ] Support for filtering on nullable columns
- [ ] Support for foreign macro attributes
- [ ] Support for generics
- [ ] ... ?
#### License
Licensed under either of
Apache License, Version 2.0 or
MIT license
at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in this crate by you, as defined in the Apache-2.0 license, shall
be dual licensed as above, without any additional terms or conditions.