History

Sergio Benitez 926e06ef3c Finalize 'tracing' migration. This commit complete the migration to 'tracing' for all logging. Below is a summary of all relevant commits, including this one: Log improvements: - All log (trace) messages are structured which means they contain fields that can formatted by any subscriber. - Logging can be disabled entirely by disabling the default `trace` feature. - Routes and catchers now contain location (file/line) information. - Two log format kinds: pretty and compact via ROCKET_LOG_FORMAT - Coloring is not disabled globally. Thus applications can color even if Rocket is configured not to. - Rocket is more conservative about 'warn' and 'error' messages, reserving those log levels for messages useful in production. - Errors from guards logged by codegen now use the 'Display' implementation of those errors when one exists. - Secrets are never logged, even when directly asked for. New features: - Many Rocket types know how to trace themselves via a new `Trace` trait. - `Either` types can now be used in `uri!()` calls. - A `RequestIdLayer` tags all requests with a unique ID. Breaking changes to configuration: - `Config::log_level` is of type `Option<Level>`. `None` disables tracing. - `log_level` now uses the traditional log level names: "off", "error", "warn", "info", "debug", "trace", or 0-5. This replace the Rocket-specific "normal", "debug", "critical". - A new option, `log_format`, which is either `compact` or `pretty`, determines how Rocket's tracing subscriber log trace messages. Breaking changes: - Hidden `rocket::Either` is now publicly available at `rocket::either::Either`. - `rocket::Error` no longer panics when dropped. - `main` generated by `#[launch]` returns an `ExitCode`. - `FromParam` `Err` now always returns the actual error as opposed to the string that failed to parse. To recover the original string, use `Either<T, &str>`, where `T: FromParam`, as a parameter guard. - Many types that implemented `Display` now instead implement `Trace`. - `Error::pretty_print()` was removed. Use `Error::trace()` via `Trace` impl. Internal improvements: - Made more space in CI machines for tasks. - Cleaned up testbench code using `inventory`. Resolves #21.		2024-06-03 15:02:44 -07:00
..
codegen	Use workspace lints. Resolve new nightly warnings.	2024-05-20 13:39:14 -05:00
lib	Finalize 'tracing' migration.	2024-06-03 15:02:44 -07:00
README.md	Update 'SergioBenitez/Rocket' to 'rwf2/Rocket'.	2023-11-21 16:32:25 +01: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"
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
}