5 releases

0.2.0 May 23, 2024
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

#1433 in Database interfaces

Download history 879/week @ 2024-02-15 1195/week @ 2024-02-22 1196/week @ 2024-02-29 979/week @ 2024-03-07 1033/week @ 2024-03-14 1198/week @ 2024-03-21 1180/week @ 2024-03-28 1202/week @ 2024-04-04 1394/week @ 2024-04-11 1831/week @ 2024-04-18 2221/week @ 2024-04-25 1423/week @ 2024-05-02 1502/week @ 2024-05-09 1627/week @ 2024-05-16 2127/week @ 2024-05-23 1300/week @ 2024-05-30

6,841 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.2.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–56MB
~1M SLoC