rocket_db_pools_codegen

Crates.iorocket_db_pools_codegen
lib.rsrocket_db_pools_codegen
version0.2.0
sourcesrc
created_at2022-05-09 14:12:37.904587
updated_at2024-05-23 20:35:31.216245
descriptionProcedural macros for rocket_db_pools.
homepage
repositoryhttps://github.com/rwf2/Rocket/tree/v0.5/contrib/db_pools
max_upload_size
id583233
size34,977
Sergio Benitez (SergioBenitez)

documentation

README

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
    }
    
Commit count: 2385

cargo fmt