在 Rust 專案使用 Diesel 操作 PostgreSQL 資料庫

Diesel
, , , ,

前置作業

PostgreSQL CLI

安裝 libpq 工具。

1
brew install libpq

添加指令到環境變數。

1
echo 'export PATH="/usr/local/opt/libpq/bin:$PATH"' >> ~/.zshrc

Diesel CLI

安裝 diesel_cli 工具。

1
cargo install diesel_cli --no-default-features --features postgres

建立專案

建立專案。

1
2
cargo new diesel-example
cd diesel-example

安裝依賴套件。

1
2
cargo add diesel --features postgres
cargo add dotenvy

新增 .env 檔。

1
DATABASE_URL=postgres://postgres:[email protected]/posts

使用 diesel 指令初始化，以建立 posts 資料庫和預設的遷移資料表。

1
diesel setup

建立遷移

建立 posts 資料表。

1
diesel migration generate create_posts

修改 migrations/2022-10-10-082606_create_posts/up.sql 檔。

1
2
3
4
5
6
CREATE TABLE posts (
  id SERIAL PRIMARY KEY,
  title VARCHAR(255) NOT NULL,
  body TEXT NOT NULL,
  published BOOLEAN NOT NULL DEFAULT FALSE
)

修改 migrations/2022-10-10-082606_create_posts/down.sql 檔。

1
DROP TABLE posts

執行遷移。

1
diesel migration run

如果要回滾，可以執行以下指令。

1
diesel migration redo

建立連線

新增 src/lib.rs 檔。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
use diesel::pg::PgConnection;
use diesel::prelude::*;
use dotenvy::dotenv;
use std::env;

pub mod models;
pub mod schema;

pub fn establish_connection() -> PgConnection {
    dotenv().ok();

    let database_url = env::var("DATABASE_URL").expect("DATABASE_URL must be set");
    PgConnection::establish(&database_url)
        .unwrap_or_else(|_| panic!("Error connecting to {}", database_url))
}

存取資料

讀取文章

新增 src/models.rs 檔。

1
2
3
4
5
6
7
8
9
use diesel::prelude::*;

#[derive(Queryable)]
pub struct Post {
    pub id: i32,
    pub title: String,
    pub body: String,
    pub published: bool,
}

修改 src/lib.rs 檔。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
use self::models::{NewPost, Post};
use diesel::pg::PgConnection;
use diesel::prelude::*;
use dotenvy::dotenv;
use std::env;

// ...

pub fn load_posts(conn: &mut PgConnection) -> Vec<Post> {
    use self::schema::posts::dsl::{posts, published};

    posts
        .filter(published.eq(true))
        .limit(5)
        .load::<Post>(conn)
        .expect("Error loading posts")
}

新增 src/bin/show_posts.rs 檔。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
use diesel_example::*;

fn main() {
    let connection = &mut establish_connection();
    let results = load_posts(connection);

    println!("Displaying {} posts", results.len());

    for post in results {
        println!("{}", post.title);
        println!("===\n");
        println!("{}", post.body);
    }
}

執行程式。

1
cargo run --bin show_posts

新增文章

修改 src/models.rs 檔。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
use diesel::prelude::*;
use crate::schema::posts;

#[derive(Queryable)]
pub struct Post {
    pub id: i32,
    pub title: String,
    pub body: String,
    pub published: bool,
}

#[derive(Insertable)]
#[diesel(table_name = posts)]
pub struct NewPost<'a> {
    pub title: &'a str,
    pub body: &'a str,
}

修改 src/lib.rs 檔。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
use self::models::{NewPost, Post};
use diesel::pg::PgConnection;
use diesel::prelude::*;
use dotenvy::dotenv;
use std::env;

// ...

pub fn create_post(conn: &mut PgConnection, title: &str, body: &str) -> Post {
    use crate::schema::posts;

    let new_post = NewPost { title, body };

    diesel::insert_into(posts::table)
        .values(&new_post)
        .get_result(conn)
        .expect("Error creating post")
}

新增 src/bin/create_post.rs 檔。

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
use diesel_example::*;
use std::io::{stdin, Read};

fn main() {
    let connection = &mut establish_connection();

    let mut title = String::new();
    let mut body = String::new();

    println!("What would you like your title to be?");
    stdin().read_line(&mut title).unwrap();
    let title = title.trim_end(); // Remove the trailing newline

    println!(
        "\nOk! Let's write {} (Press {} when finished)\n",
        title, EOF
    );
    stdin().read_to_string(&mut body).unwrap();

    let post = create_post(connection, title, &body);
    println!("\nSaved draft {} with id {}", title, post.id);
}

#[cfg(not(windows))]
const EOF: &str = "CTRL+D";

#[cfg(windows)]
const EOF: &str = "CTRL+Z";

執行程式。

1
cargo run --bin create_post

發表文章

修改 src/lib.rs 檔。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
use self::models::{NewPost, Post};
use diesel::pg::PgConnection;
use diesel::prelude::*;
use dotenvy::dotenv;
use std::env;

// ...

pub fn publish_post(conn: &mut PgConnection, id: &i32) -> Post {
    use self::schema::posts::dsl::{posts, published};

    diesel::update(posts.find(id))
        .set(published.eq(true))
        .get_result::<Post>(conn)
        .expect("Error updating post")
}

新增 src/bin/publish_post.rs 檔。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
use diesel_example::*;
use std::env::args;

fn main() {
    let id = args()
        .nth(1)
        .expect("publish_post requires a post id")
        .parse::<i32>()
        .expect("Invalid ID");
    let connection = &mut establish_connection();

    let post = publish_post(connection, &id);

    println!("Published post {}", post.title);
}

執行程式。

1
cargo run --bin publish_post 1

查看文章列表。

1
cargo run --bin show_posts

刪除文章

修改 src/lib.rs 檔。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
use self::models::{NewPost, Post};
use diesel::pg::PgConnection;
use diesel::prelude::*;
use dotenvy::dotenv;
use std::env;

// ...

pub fn delete_post(conn: &mut PgConnection, id: &i32) -> usize {
    use self::schema::posts::dsl::posts;

    diesel::delete(posts.find(id))
        .execute(conn)
        .expect("Error deleting post")
}

新增 src/bin/delete_post.rs 檔。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
use diesel_example::*;
use std::env::args;

fn main() {
    let id = args()
        .nth(1)
        .expect("delete_post requires a post id")
        .parse::<i32>()
        .expect("Invalid ID");
    let connection = &mut establish_connection();

    let num_deleted = delete_post(connection, &id);

    println!("Deleted {} posts", num_deleted);
}

執行程式。

1
cargo run --bin delete_post 1

查看文章列表。

1
cargo run --bin show_posts

程式碼

參考資料