sqly 0.4.0

A lightweight macro system on top of sqlx
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100

sqly
[<img alt="github.com" src="https://img.shields.io/badge/github.com-LMOORS30/sqly-5e728a?labelColor=343942&style=for-the-badge&logo=github" height="20">](https://github.com/LMOORS30/sqly)
[<img alt="crates.io" src="https://img.shields.io/badge/crates.io-sqly-5e888a?labelColor=343942&style=for-the-badge&logo=rust" height="20">](https://crates.io/crates/sqly)
[<img alt="docs.rs" src="https://img.shields.io/badge/docs.rs-sqly-5e8a76?labelColor=343942&style=for-the-badge&logo=docs.rs" height="20">](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)).
<br>
<br>
##### Cargo.toml
```toml
[dependencies.sqly]
version = "0.4.0"
features = ["postgres"]

[dependencies.sqlx]
version = "0.8.0"
default-features = false

[profile.dev.package.sqlx-macros]
opt-level = 3

[profile.dev.package.sqly-macros]
opt-level = 3
```

##### Features
`postgres`&ensp;—&ensp;generate queries for PostgreSQL<br>
` mariadb`&ensp;—&ensp;generate queries for MariaDB (not supported)<br>
`  sqlite`&ensp;—&ensp;generate queries for SQLite (not supported)<br>
`   mysql`&ensp;—&ensp;generate queries for MySQL (not supported)<br>
` checked`&ensp;—&ensp;enable compile-time checking (default)

Currently only postgres is supported.

<br>

### Usage
[<img alt="docs.rs" src="https://img.shields.io/badge/docs.rs-sqly-5e8a76?labelColor=343942&style=for-the-badge&logo=docs.rs" height="30">](https://docs.rs/sqly)

<br>

### Roadmap
**Major**
- [X] Basic `DELETE` queries
- [X] Basic `INSERT` queries
- [X] Basic `UPDATE` queries
- [X] Basic `SELECT` queries
    - [X] Storing information across separate `#[derive]` invocations
    - [ ] Optional outer macro pattern for better compiler support
- [X] `#[sqly(foreign)]`
    - [X] SQL `INNER JOIN`
    - [X] SQL `LEFT JOIN`
    - [X] Custom SQL joins
    - [X] Unique table aliases
- [ ] `sqly::query!` macros to extend generated queries

**Minor**
- [X] `Flat::Flat` type for flexibility
- [X] `#[sqly(infer)]` for custom sqlx types
- [X] `#[sqly(value)]` for custom parameter binding
- [X] `#[sqly(select)]` for custom SQL select expressions
- [X] `#[sqly(default, from)]` for decoding table fields
- [X] `#[sqly(insert, update)]` for custom SQL value expressions
- [X] `#[sqly(filter)]` for custom SQL filter expressions
- [X] `#[sqly(optional)]` for dynamic SQL through optional fields
- [X] `#[sqly(returning)]` for SQL `RETURNING` clause

**Draft**
- [ ] `#[sqly(group)]` for SQL `GROUP BY` clause
- [ ] `#[sqly(distinct, order, limit, offset)]` clauses
- [ ] Decoding database rows unchecked or by index
- [ ] Custom attributes in generated structs
- [ ] Support for generic structs
- [ ] ... ?

<br>

#### License

<sup>
Licensed under either of
<a href="LICENSE-APACHE">Apache License, Version 2.0</a> or
<a href="LICENSE-MIT">MIT license</a>
at your option.
</sup>

<br>

<sub>
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.
</sub>