pgorm 0.3.0

A model-definition-first, AI-friendly PostgreSQL ORM for Rust
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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132

//! Example demonstrating PgEnum derive for PostgreSQL ENUM types.
//!
//! Run with:
//!   cargo run --example pg_enum -p pgorm
//!
//! Requires:
//!   DATABASE_URL=postgres://postgres:postgres@localhost/pgorm_example

use pgorm::{OrmError, OrmResult, PgEnum, RowExt, query};
use std::env;

#[derive(PgEnum, Debug, Clone, PartialEq)]
#[orm(pg_type = "order_status")]
pub enum OrderStatus {
    #[orm(rename = "pending")]
    Pending,
    #[orm(rename = "processing")]
    Processing,
    #[orm(rename = "shipped")]
    Shipped,
    #[orm(rename = "delivered")]
    Delivered,
    #[orm(rename = "cancelled")]
    Cancelled,
}

#[tokio::main]
async fn main() -> OrmResult<()> {
    dotenvy::dotenv().ok();
    let database_url = env::var("DATABASE_URL")
        .map_err(|_| OrmError::Connection("DATABASE_URL is not set".into()))?;

    let (client, connection) = tokio_postgres::connect(&database_url, tokio_postgres::NoTls)
        .await
        .map_err(OrmError::from_db_error)?;
    tokio::spawn(async move {
        let _ = connection.await;
    });

    // ── Setup ────────────────────────────────────────────────────────────────
    query("DROP TABLE IF EXISTS orders CASCADE")
        .execute(&client)
        .await?;
    query("DROP TYPE IF EXISTS order_status CASCADE")
        .execute(&client)
        .await?;
    query(
        "CREATE TYPE order_status AS ENUM (
            'pending', 'processing', 'shipped', 'delivered', 'cancelled'
        )",
    )
    .execute(&client)
    .await?;
    query(
        "CREATE TABLE orders (
            id BIGSERIAL PRIMARY KEY,
            user_id BIGINT NOT NULL,
            status order_status NOT NULL DEFAULT 'pending',
            total NUMERIC(10,2) NOT NULL
        )",
    )
    .execute(&client)
    .await?;

    // ── Insert with enum value ───────────────────────────────────────────────
    let row = query(
        "INSERT INTO orders (user_id, status, total) VALUES ($1, $2, $3) RETURNING id, status",
    )
    .bind(1_i64)
    .bind(OrderStatus::Pending)
    .bind(99.99_f64)
    .fetch_one(&client)
    .await?;
    let id: i64 = row.try_get_column("id")?;
    let status: OrderStatus = row.try_get_column("status")?;
    println!("[1] Inserted order id={id}, status={status:?}");

    // Insert more orders
    query("INSERT INTO orders (user_id, status, total) VALUES ($1, $2, $3)")
        .bind(2_i64)
        .bind(OrderStatus::Shipped)
        .bind(149.50_f64)
        .execute(&client)
        .await?;

    query("INSERT INTO orders (user_id, status, total) VALUES ($1, $2, $3)")
        .bind(1_i64)
        .bind(OrderStatus::Processing)
        .bind(200.00_f64)
        .execute(&client)
        .await?;

    // ── Query by enum value ──────────────────────────────────────────────────
    let rows = query("SELECT id, user_id, status, total FROM orders WHERE status = $1")
        .bind(OrderStatus::Pending)
        .fetch_all(&client)
        .await?;
    println!("\n[2] Pending orders ({} found):", rows.len());
    for row in &rows {
        let id: i64 = row.try_get_column("id")?;
        let status: OrderStatus = row.try_get_column("status")?;
        println!("    order id={id}, status={status:?}");
    }

    // ── Update enum value ────────────────────────────────────────────────────
    query("UPDATE orders SET status = $1 WHERE id = $2")
        .bind(OrderStatus::Delivered)
        .bind(id)
        .execute(&client)
        .await?;

    let row = query("SELECT status FROM orders WHERE id = $1")
        .bind(id)
        .fetch_one(&client)
        .await?;
    let updated: OrderStatus = row.try_get_column("status")?;
    println!("\n[3] Updated order id={id} to status={updated:?}");

    // ── Query all, read enum from each row ───────────────────────────────────
    let rows = query("SELECT id, status FROM orders ORDER BY id")
        .fetch_all(&client)
        .await?;
    println!("\n[4] All orders:");
    for row in &rows {
        let id: i64 = row.try_get_column("id")?;
        let status: OrderStatus = row.try_get_column("status")?;
        println!("    id={id}, status={status:?}");
    }

    println!("\nDone.");
    Ok(())
}