4 releases

0.1.0 Nov 17, 2023
0.1.0-rc.4 Nov 2, 2023
0.1.0-rc.3 Mar 24, 2023
0.1.0-rc.2 May 9, 2022

#1508 in Database interfaces

Download history 602/week @ 2023-12-04 742/week @ 2023-12-11 828/week @ 2023-12-18 535/week @ 2023-12-25 478/week @ 2024-01-01 848/week @ 2024-01-08 801/week @ 2024-01-15 707/week @ 2024-01-22 895/week @ 2024-01-29 1030/week @ 2024-02-05 908/week @ 2024-02-12 1042/week @ 2024-02-19 1228/week @ 2024-02-26 1123/week @ 2024-03-04 909/week @ 2024-03-11 1245/week @ 2024-03-18

4,622 downloads per month
Used in 9 crates (7 directly)

MIT/Apache

1MB
14K SLoC

db_pools ci.svg crates.io docs.svg

Asynchronous database driver integration for Rocket. See the crate docs for full usage details.

Usage

  1. Add rocket_db_pools as a dependency with one or more database driver features enabled:

    [dependencies.rocket_db_pools]
    version = "0.1.0"
    features = ["sqlx_sqlite"]
    
  2. Choose a name for your database, here sqlite_logs. Configure at least a URL for the database:

    [default.databases.sqlite_logs]
    url = "/path/to/database.sqlite"
    
  3. Derive Database for a unit type (Logs here) which wraps the selected driver's Pool type and is decorated with #[database("name")]. Attach Type::init() to your application's Rocket to initialize the database pool:

    use rocket_db_pools::{Database, Connection};
    
    #[derive(Database)]
    #[database("sqlite_logs")]
    struct Logs(sqlx::SqlitePool);
    
    #[launch]
    fn rocket() -> _ {
        rocket::build().attach(Logs::init())
    }
    
  4. Use Connection<Type> as a request guard to retrieve an active database connection:

    #[get("/<id>")]
    async fn read(mut db: Connection<Logs>, id: i64) -> Result<Log> {
        sqlx::query!("SELECT content FROM logs WHERE id = ?", id)
            .fetch_one(&mut *db)
            .map_ok(|r| Log(r.content))
            .await
    }
    

Dependencies

~14–59MB
~1M SLoC