Skip to content

Commit 7917e84

Browse files
committed
Update root docs
1 parent 94bdf23 commit 7917e84

File tree

2 files changed

+23
-0
lines changed

2 files changed

+23
-0
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,7 @@ as well as `native-tls`-based TLS support.
8181
mysql_async = { version = "*", default-features = false, features = ["rustls-tls"] }
8282

8383
* `tracing` – enables instrumentation via `tracing` package.
84+
8485
Primary operations (`query`, `prepare`, `exec`) are instrumented at `INFO` level.
8586
Remaining operations, incl. `get_conn`, are instrumented at `DEBUG` level.
8687
Also at `DEBUG`, the SQL queries and parameters are added to the `query`, `prepare`
@@ -110,6 +111,10 @@ SSL support comes in two flavors:
110111
- it, most likely, won't work on windows, at least with default server certs,
111112
generated by the MySql installer.
112113

114+
## Connection URL parameters
115+
116+
There is a set of url-parameters supported by the driver (see documentation on [`Opts`]).
117+
113118
## Example
114119

115120
```rust

src/lib.rs

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,20 @@
7979
//! [dependencies]
8080
//! mysql_async = { version = "*", default-features = false, features = ["rustls-tls"] }
8181
//!
82+
//! * `tracing` – enables instrumentation via `tracing` package.
83+
//!
84+
//! Primary operations (`query`, `prepare`, `exec`) are instrumented at `INFO` level.
85+
//! Remaining operations, incl. `get_conn`, are instrumented at `DEBUG` level.
86+
//! Also at `DEBUG`, the SQL queries and parameters are added to the `query`, `prepare`
87+
//! and `exec` spans.
88+
//!
89+
//! **Example:**
90+
//!
91+
//! ```toml
92+
//! [dependencies]
93+
//! mysql_async = { version = "*", features = ["tracing"] }
94+
//! ```
95+
//!
8296
//! [myslqcommonfeatures]: https://github.com/blackbeam/rust_mysql_common#crate-features
8397
//!
8498
//! # TLS/SSL Support
@@ -96,6 +110,10 @@
96110
//! - it, most likely, won't work on windows, at least with default server certs,
97111
//! generated by the MySql installer.
98112
//!
113+
//! # Connection URL parameters
114+
//!
115+
//! There is a set of url-parameters supported by the driver (see documentation on [`Opts`]).
116+
//!
99117
//! # Example
100118
//!
101119
//! ```rust

0 commit comments

Comments
 (0)