sqlx-modes is a work in progress implementation for a sql migration management tool for applications using sqlx.
install the CLI by running the following command:
cargo install sqlx-models-cli
Now run the following command to create an environment file with the DATABASE_URL variable set:
echo "DATABASE_URL=sqlite:/database.db" > .env
We now can create the database running the command:
sqlx database create
This command will have created an sqlite file called database.db.
You can now derive the Models trait on your structures,
and sqlx-models will manage the migrations for you. For example, write at src/main.rs:
```rust
use sqlx_models::Model;
struct User { #[primarykey] id: i32, #[unique] email: String, password: String, #[default = 0] isadmin: bool, }
struct Post {
#[primarykey]
id: i32,
#[foreignkey(User.id)]
author_: String,
#[default = "
struct PostLike { #[foreignkey(User.id)] #[primarykey(postid)] userid: i32, #[foreignkey(Post.id)] postid: i32, }
struct CommentLike { #[foreignkey(User.id)] #[primarykey(comment)] user: i32, #[foreignkey(Comment.id)] comment: i32, #[default = false] isdislike: bool, }
struct Comment { #[primarykey] id: i32, #[foreignkey(User.id)] author: i32, #[foreign_key(Post.id)] post: i32, } fn main() {} ```
If you now run the following command, your migrations should be automatically created.
sqlx generate
The output should look like this:
Generated 1631716729974/migrate user
Generated 1631716729980/migrate post
Generated 1631716729986/migrate comment
Generated 1631716729993/migrate postlike
Generated 1631716729998/migrate commentlike
You can check out the generated migrations at the migrations/ folder. To commit this migrations you can execute the following command:
sqlx migrate run
The output should look like this:
Applied 1631716729974/migrate user (342.208µs)
Applied 1631716729980/migrate post (255.958µs)
Applied 1631716729986/migrate comment (287.792µs)
Applied 1631716729993/migrate postlike (349.834µs)
Applied 1631716729998/migrate commentlike (374.625µs)
If we later modify those structures in our application, we can generate new migrations to update the tables.
It's used to mark the primary key fo the table.
rust
#[primary_key]
id: i32,
for tables with multicolumn primary keys, the following syntax is used:
rust
#[primary_key(second_id)]
first_id: i32,
second_id: i32,
It is used to mark a foreign key constraint.
rust
#[foreign_key(User.id)]
user: i32,
It can also specify on_delete and on_update constraints:
rust
#[foreign_key(User.id, on_delete="cascade"]
user: i32,
It can be used to set a default for a table.
rust
#[default = 0]
is_admin: bool,
It is used to mark a unique constraint.
rust
#[unique]
email: String,
For multicolumn unique constraints the following syntax is used:
rust
#[unique(hash)]
username: String,
hash: i32,