https://github.com/peterhenryd/supermodel
Supermodel is an abstract data-modeling library written in Rust.
https://github.com/peterhenryd/supermodel
sql
Last synced: 10 months ago
JSON representation
Supermodel is an abstract data-modeling library written in Rust.
- Host: GitHub
- URL: https://github.com/peterhenryd/supermodel
- Owner: peterhenryd
- License: mit
- Created: 2024-02-09T02:44:00.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-19T19:55:03.000Z (almost 2 years ago)
- Last Synced: 2024-11-09T06:10:33.386Z (over 1 year ago)
- Topics: sql
- Language: Rust
- Homepage:
- Size: 72.3 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Roadmap: ROADMAP.md
Awesome Lists containing this project
README
# supermodel
[](https://crates.io/crates/supermodel)
[](https://crates.io/crates/supermodel-macros)
[](https://crates.io/crates/supermodel-sqlx)
Supermodel is an abstract data-modeling library. It provides an interface for creating, editing, and modifying data in various types of databases and APIs.
## Goals
- **Be generic.** The library tries be as abstract as possible. This allows the same code to be used for multiple purposes. Moreover, this means prioritizing the Rust type system over the type system of a database implementation.
- **Be intuitive.** Supermodel is centered around the `Model` and `Dialect` trait. With an implementation of a Dialect (typically through a crate like `supermodel-sqlx`) and an implementation of a Model (typically through the `model` proc-macro), all of Supermodel's features can be accessed.
- **Be fast.** While I would not consider myself skilled at high-performance Rust, this library aims to be only a thin layer over its implementations when it comes to runtime performance.
## Examples
```rs
#[model(Postgres)]
#[name = "users"]
pub struct User {
username: String,
password: String
}
#[tokio::main]
async fn main() -> Result<(), sqlx::Error> {
dotenv().expect("initializing .env file");
let url = std::env::var("DATABASE_URL").expect("missing DATABASE_URL in env");
let mut connection = Postgres::create_connection(&url).await?;
User::register().execute(&mut connection).await?;
Ok(())
}
```
Generated SQL:
```sql
create table if not exists users
(
id bigserial
primary key,
username varchar(30),
password varchar(30)
);
```
Check out some more example programs written with Supermodel [here](https://github.com/peterhenryd/supermodel/tree/main/packages/supermodel/examples).
## Usability
Supermodel currently compiles, but is largely unusable. It only supports a handful of data types and many operations are unimplemented. Moreover, the API is very unstable as I haven't yet decided the best way to go about certain things.
## Roadmap
Check out the plans for the future of this library [here](https://github.competerhenryd/supermodel/tree/main/ROADMAP.md).