rocket_sync_db_pools_codegen

Crates.iorocket_sync_db_pools_codegen
lib.rsrocket_sync_db_pools_codegen
version0.1.0
sourcesrc
created_at2021-06-09 16:57:23.26313
updated_at2023-11-17 17:07:00.803728
descriptionProcedural macros for rocket_sync_db_pools.
homepage
repositoryhttps://github.com/SergioBenitez/Rocket/contrib/sync_db_pools
max_upload_size
id408240
size26,301
Sergio Benitez (SergioBenitez)

documentation

README

sync_db_pools ci.svg crates.io docs.svg

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.

Commit count: 2297

cargo fmt