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

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

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

#[derive(PgComposite, Debug, Clone)]
#[orm(pg_type = "address")]
pub struct Address {
    pub street: String,
    pub city: String,
    pub zip_code: String,
    pub country: String,
}

#[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 contacts CASCADE")
        .execute(&client)
        .await?;
    query("DROP TYPE IF EXISTS address CASCADE")
        .execute(&client)
        .await?;
    query(
        "CREATE TYPE address AS (
            street TEXT,
            city TEXT,
            zip_code TEXT,
            country TEXT
        )",
    )
    .execute(&client)
    .await?;
    query(
        "CREATE TABLE contacts (
            id BIGSERIAL PRIMARY KEY,
            name TEXT NOT NULL,
            home_address address NOT NULL
        )",
    )
    .execute(&client)
    .await?;

    // ── Insert with composite value ──────────────────────────────────────────
    let addr = Address {
        street: "123 Main St".into(),
        city: "San Francisco".into(),
        zip_code: "94105".into(),
        country: "USA".into(),
    };

    let row =
        query("INSERT INTO contacts (name, home_address) VALUES ($1, $2) RETURNING id, name, home_address")
            .bind("Alice")
            .bind(addr.clone())
            .fetch_one(&client)
            .await?;
    let id: i64 = row.try_get_column("id")?;
    let name: String = row.try_get_column("name")?;
    let read_addr: Address = row.try_get_column("home_address")?;
    println!("[1] Inserted: id={id}, name={name}");
    println!(
        "    address: {} {}, {} {}",
        read_addr.street, read_addr.city, read_addr.zip_code, read_addr.country
    );

    // Insert another contact
    let addr2 = Address {
        street: "456 Oak Ave".into(),
        city: "New York".into(),
        zip_code: "10001".into(),
        country: "USA".into(),
    };
    query("INSERT INTO contacts (name, home_address) VALUES ($1, $2)")
        .bind("Bob")
        .bind(addr2)
        .execute(&client)
        .await?;

    // ── Read all ─────────────────────────────────────────────────────────────
    let rows = query("SELECT id, name, home_address FROM contacts ORDER BY id")
        .fetch_all(&client)
        .await?;
    println!("\n[2] All contacts:");
    for row in &rows {
        let id: i64 = row.try_get_column("id")?;
        let name: String = row.try_get_column("name")?;
        let addr: Address = row.try_get_column("home_address")?;
        println!(
            "    id={id} name={name:8} city={}, country={}",
            addr.city, addr.country
        );
    }

    // ── Query on composite field ─────────────────────────────────────────────
    // PostgreSQL allows accessing composite fields with (column).field syntax
    let rows = query("SELECT id, name FROM contacts WHERE (home_address).city = $1")
        .bind("San Francisco")
        .fetch_all(&client)
        .await?;
    println!("\n[3] Contacts in San Francisco ({} found):", rows.len());
    for row in &rows {
        let name: String = row.try_get_column("name")?;
        println!("    {name}");
    }

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