History

Sergio Benitez b6430e9970 Rename 'Outcome::Failure' to 'Outcome::Error'. The primary motivation is to deconflate the leading `F`s in `Failure` and `Forward`. In particular, when using a generics, we used `F` for forward, which could easily be confused for `F` for `Failure`. This resolves the conflation.		2023-11-01 18:50:55 -05:00
..
codegen	Rename 'Outcome::Failure' to 'Outcome::Error'.	2023-11-01 18:50:55 -05:00
lib	Rename 'Outcome::Failure' to 'Outcome::Error'.	2023-11-01 18:50:55 -05:00
README.md	New version: 0.5.0-rc.3.	2023-03-23 16:56:17 -07:00

README.md

`db_pools`

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

Usage

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

[dependencies.rocket_db_pools]
version = "=0.1.0-rc.3"
features = ["sqlx_sqlite"]

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"
```

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())
}

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
}