Skip to content

Commit

Permalink
Update root docs
Browse files Browse the repository at this point in the history
  • Loading branch information
blackbeam committed Jan 31, 2023
1 parent 94bdf23 commit 7917e84
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ as well as `native-tls`-based TLS support.
mysql_async = { version = "*", default-features = false, features = ["rustls-tls"] }

* `tracing` – enables instrumentation via `tracing` package.

Primary operations (`query`, `prepare`, `exec`) are instrumented at `INFO` level.
Remaining operations, incl. `get_conn`, are instrumented at `DEBUG` level.
Also at `DEBUG`, the SQL queries and parameters are added to the `query`, `prepare`
Expand Down Expand Up @@ -110,6 +111,10 @@ SSL support comes in two flavors:
- it, most likely, won't work on windows, at least with default server certs,
generated by the MySql installer.

## Connection URL parameters

There is a set of url-parameters supported by the driver (see documentation on [`Opts`]).

## Example

```rust
Expand Down
18 changes: 18 additions & 0 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,20 @@
//! [dependencies]
//! mysql_async = { version = "*", default-features = false, features = ["rustls-tls"] }
//!
//! * `tracing` – enables instrumentation via `tracing` package.
//!
//! Primary operations (`query`, `prepare`, `exec`) are instrumented at `INFO` level.
//! Remaining operations, incl. `get_conn`, are instrumented at `DEBUG` level.
//! Also at `DEBUG`, the SQL queries and parameters are added to the `query`, `prepare`
//! and `exec` spans.
//!
//! **Example:**
//!
//! ```toml
//! [dependencies]
//! mysql_async = { version = "*", features = ["tracing"] }
//! ```
//!
//! [myslqcommonfeatures]: https://github.com/blackbeam/rust_mysql_common#crate-features
//!
//! # TLS/SSL Support
Expand All @@ -96,6 +110,10 @@
//! - it, most likely, won't work on windows, at least with default server certs,
//! generated by the MySql installer.
//!
//! # Connection URL parameters
//!
//! There is a set of url-parameters supported by the driver (see documentation on [`Opts`]).
//!
//! # Example
//!
//! ```rust
Expand Down

0 comments on commit 7917e84

Please sign in to comment.