From 686b64fbec32ccec12a3e489227daa59bbaef33a Mon Sep 17 00:00:00 2001
From: Mika Bomm <mika.bomm@outlook.com>
Date: Thu, 27 Mar 2025 13:14:27 +0100
Subject: [PATCH] add migration crate

---
 .env.example                     |  5 +++-
 crates/migration/Cargo.toml      | 22 +++++++++++++++++
 crates/migration/README.md       | 41 ++++++++++++++++++++++++++++++++
 crates/migration/src/baseline.rs | 41 ++++++++++++++++++++++++++++++++
 crates/migration/src/lib.rs      | 12 ++++++++++
 crates/migration/src/main.rs     |  6 +++++
 6 files changed, 126 insertions(+), 1 deletion(-)
 create mode 100644 crates/migration/Cargo.toml
 create mode 100644 crates/migration/README.md
 create mode 100644 crates/migration/src/baseline.rs
 create mode 100644 crates/migration/src/lib.rs
 create mode 100644 crates/migration/src/main.rs

diff --git a/.env.example b/.env.example
index d78c3ae..75450d7 100644
--- a/.env.example
+++ b/.env.example
@@ -1,3 +1,6 @@
 DB_NAME=
 DB_USER=
-DB_PASSWORD=
\ No newline at end of file
+DB_PASSWORD=
+DB_HOST=
+
+DATABASE_URL=postgresql://${DB_USER}:${DB_PASSWORD}@${DB_HOST}/${DB_NAME}
\ No newline at end of file
diff --git a/crates/migration/Cargo.toml b/crates/migration/Cargo.toml
new file mode 100644
index 0000000..d43a58e
--- /dev/null
+++ b/crates/migration/Cargo.toml
@@ -0,0 +1,22 @@
+[package]
+name = "migration"
+version = { workspace = true }
+edition = { workspace = true }
+publish = false
+
+[lib]
+name = "migration"
+path = "src/lib.rs"
+
+[dependencies]
+async-std = { version = "1", features = ["attributes", "tokio1"] }
+
+[dependencies.sea-orm-migration]
+version = "1.1.0"
+features = [
+  # Enable at least one `ASYNC_RUNTIME` and `DATABASE_DRIVER` feature if you want to run migration via CLI.
+  # View the list of supported features at https://www.sea-ql.org/SeaORM/docs/install-and-config/database-and-async-runtime.
+  # e.g.
+  "runtime-tokio-rustls", # `ASYNC_RUNTIME` feature
+  "sqlx-postgres",        # `DATABASE_DRIVER` feature
+]
diff --git a/crates/migration/README.md b/crates/migration/README.md
new file mode 100644
index 0000000..3b438d8
--- /dev/null
+++ b/crates/migration/README.md
@@ -0,0 +1,41 @@
+# Running Migrator CLI
+
+- Generate a new migration file
+    ```sh
+    cargo run -- generate MIGRATION_NAME
+    ```
+- Apply all pending migrations
+    ```sh
+    cargo run
+    ```
+    ```sh
+    cargo run -- up
+    ```
+- Apply first 10 pending migrations
+    ```sh
+    cargo run -- up -n 10
+    ```
+- Rollback last applied migrations
+    ```sh
+    cargo run -- down
+    ```
+- Rollback last 10 applied migrations
+    ```sh
+    cargo run -- down -n 10
+    ```
+- Drop all tables from the database, then reapply all migrations
+    ```sh
+    cargo run -- fresh
+    ```
+- Rollback all applied migrations, then reapply all migrations
+    ```sh
+    cargo run -- refresh
+    ```
+- Rollback all applied migrations
+    ```sh
+    cargo run -- reset
+    ```
+- Check the status of all migrations
+    ```sh
+    cargo run -- status
+    ```
diff --git a/crates/migration/src/baseline.rs b/crates/migration/src/baseline.rs
new file mode 100644
index 0000000..1863d6d
--- /dev/null
+++ b/crates/migration/src/baseline.rs
@@ -0,0 +1,41 @@
+use sea_orm_migration::{prelude::*, schema::*};
+
+#[derive(DeriveMigrationName)]
+pub struct Migration;
+
+#[async_trait::async_trait]
+impl MigrationTrait for Migration {
+    async fn up(&self, manager: &SchemaManager) -> Result<(), DbErr> {
+        // Replace the sample below with your own migration scripts
+        todo!();
+
+        manager
+            .create_table(
+                Table::create()
+                    .table(Post::Table)
+                    .if_not_exists()
+                    .col(pk_auto(Post::Id))
+                    .col(string(Post::Title))
+                    .col(string(Post::Text))
+                    .to_owned(),
+            )
+            .await
+    }
+
+    async fn down(&self, manager: &SchemaManager) -> Result<(), DbErr> {
+        // Replace the sample below with your own migration scripts
+        todo!();
+
+        manager
+            .drop_table(Table::drop().table(Post::Table).to_owned())
+            .await
+    }
+}
+
+#[derive(DeriveIden)]
+enum Post {
+    Table,
+    Id,
+    Title,
+    Text,
+}
diff --git a/crates/migration/src/lib.rs b/crates/migration/src/lib.rs
new file mode 100644
index 0000000..ae6772d
--- /dev/null
+++ b/crates/migration/src/lib.rs
@@ -0,0 +1,12 @@
+pub use sea_orm_migration::prelude::*;
+
+mod baseline;
+
+pub struct Migrator;
+
+#[async_trait::async_trait]
+impl MigratorTrait for Migrator {
+    fn migrations() -> Vec<Box<dyn MigrationTrait>> {
+        vec![Box::new(baseline::Migration)]
+    }
+}
diff --git a/crates/migration/src/main.rs b/crates/migration/src/main.rs
new file mode 100644
index 0000000..c6b6e48
--- /dev/null
+++ b/crates/migration/src/main.rs
@@ -0,0 +1,6 @@
+use sea_orm_migration::prelude::*;
+
+#[async_std::main]
+async fn main() {
+    cli::run_cli(migration::Migrator).await;
+}