History

Sergio Benitez 87f80714fa Update 'diesel-async' in 'db_pools' to 0.5. Also modifies the `databases` example so that it makes use of the new ability to run migrations in diesel-async v0.5. To accomplish this, `diesel_async::async_connection_wrapper::AsyncConnectionWrapper` is exported from `rocket_db_pools::diesel` and used in the `diesel_mysql` portion of the `databases` example. The URL for the MySQL version of the database example is now `/mysql` instead of `/diesel-async`.		2024-08-14 18:36:56 -07:00
..
codegen	Use workspace lints. Resolve new nightly warnings.	2024-05-20 13:39:14 -05:00
lib	Update 'diesel-async' in 'db_pools' to 0.5.	2024-08-14 18:36:56 -07:00
README.md	Update 'SergioBenitez/Rocket' to 'rwf2/Rocket'.	2023-11-21 16:32:25 +01:00

README.md

`sync_db_pools`

This crate provides traits, utilities, and a procedural macro for configuring and accessing database connection pools in Rocket. This implementation is backed by r2d2 and exposes connections through request guards.

Usage

First, enable the feature corresponding to your database type:

[dependencies.rocket_sync_db_pools]
version = "0.1.0"
features = ["diesel_sqlite_pool"]

A full list of supported databases and their associated feature names is available in the crate docs. In whichever configuration source you choose, configure a databases dictionary with a key for each database, here sqlite_logs in a TOML source:

[default.databases]
sqlite_logs = { url = "/path/to/database.sqlite" }

In your application's source code:

#[macro_use] extern crate rocket;

use rocket_sync_db_pools::{database, diesel};

#[database("sqlite_logs")]
struct LogsDbConn(diesel::SqliteConnection);

#[get("/logs/<id>")]
async fn get_logs(conn: LogsDbConn, id: usize) -> Result<Logs> {
    conn.run(|c| Logs::by_id(c, id)).await
}

#[launch]
fn rocket() -> _ {
    rocket::build().attach(LogsDbConn::fairing())
}

See the crate docs for full details.