https://github.com/rubyonworld/rust_mysql_common
This crate is an implementation of basic MySql protocol primitives.
https://github.com/rubyonworld/rust_mysql_common
crate mysql primitive protocol
Last synced: about 1 month ago
JSON representation
This crate is an implementation of basic MySql protocol primitives.
- Host: GitHub
- URL: https://github.com/rubyonworld/rust_mysql_common
- Owner: RubyOnWorld
- License: apache-2.0
- Created: 2022-09-06T13:51:40.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-09-13T21:59:07.000Z (over 3 years ago)
- Last Synced: 2025-05-19T20:32:29.467Z (about 1 year ago)
- Topics: crate, mysql, primitive, protocol
- Language: Rust
- Homepage:
- Size: 3.96 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
[](https://gitter.im/rust-mysql/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
[](https://crates.io/crates/mysql_common)
[](https://docs.rs/mysql_common)
[](https://travis-ci.org/blackbeam/rust_mysql_common)
# mysql_common
This crate is an implementation of basic MySql protocol primitives.
This crate:
* defines basic MySql constants;
* implements necessary functionality for MySql `cached_sha2_password`,
`mysql_native_password` and legacy authentication plugins;
* implements helper traits for MySql protocol IO;
* implements support of named parameters for prepared statements;
* implements parsers for a subset of MySql protocol packets (including binlog packets);
* defines rust representation of MySql protocol value and row;
* implements conversion between MySql values and rust types, between MySql rows and tuples
of rust types.
### Supported rust types
Crate offers conversion from/to MySql values for following types (please see MySql documentation
on supported ranges for numeric types). Following table refers to MySql protocol types
(see `Value` struct) and not to MySql column types. Please see [MySql documentation][1] for
column and protocol type correspondence:
| Type | Notes |
| ------------------------------------ | ------------------------------------------------------- |
| `{i,u}8..{i,u}128`, `{i,u}size` | MySql int/uint will be converted, bytes will be parsed.
⚠️ Note that range of `{i,u}128` is greater than supported by MySql integer types but it'll be serialized anyway (as decimal bytes string). |
| `f32` | MySql float will be converted to `f32`, bytes will be parsed as `f32`.
⚠️ MySql double won't be converted to `f32` to avoid precision loss (see #17) |
| `f64` | MySql float and double will be converted to `f64`, bytes will be parsed as `f64`. |
| `bool` | MySql int {`0`, `1`} or bytes {`"0x30"`, `"0x31"`} |
| `Vec` | MySql bytes |
| `String` | MySql bytes parsed as utf8 |
| `Duration` (`std` and `time`) | MySql time or bytes parsed as MySql time string |
| [`time::PrimitiveDateTime`] (v0.2.x) | MySql date time or bytes parsed as MySql date time string (⚠️ lossy! microseconds are ignored) |
| [`time::Date`] (v0.2.x) | MySql date or bytes parsed as MySql date string (⚠️ lossy! microseconds are ignored) |
| [`time::Time`] (v0.2.x) | MySql time or bytes parsed as MySql time string (⚠️ lossy! microseconds are ignored) |
| [`time::Duration`] (v0.2.x) | MySql time or bytes parsed as MySql time string |
| [`time::PrimitiveDateTime`] (v0.3.x) | MySql date time or bytes parsed as MySql date time string (⚠️ lossy! microseconds are ignored) |
| [`time::Date`] (v0.3.x) | MySql date or bytes parsed as MySql date string (⚠️ lossy! microseconds are ignored) |
| [`time::Time`] (v0.3.x) | MySql time or bytes parsed as MySql time string (⚠️ lossy! microseconds are ignored) |
| [`time::Duration`] (v0.3.x) | MySql time or bytes parsed as MySql time string |
| [`chrono::NaiveTime`] | MySql date or bytes parsed as MySql date string |
| [`chrono::NaiveDate`] | MySql date or bytes parsed as MySql date string |
| [`chrono::NaiveDateTime`] | MySql date or bytes parsed as MySql date string |
| [`uuid::Uuid`] | MySql bytes parsed using `Uuid::from_slice` |
| [`serde_json::Value`] | MySql bytes parsed using `serde_json::from_str` |
| `mysql_common::Deserialized` | MySql bytes parsed using `serde_json::from_str` |
| `Option` | Must be used for nullable columns to avoid errors |
| [`decimal::Decimal`] | MySql int, uint or bytes parsed using `Decimal::from_str`.
⚠️ Note that this type doesn't support full range of MySql `DECIMAL` type. |
| [`bigdecimal::BigDecimal`] (v0.2.x) | MySql int, uint, floats or bytes parsed using `BigDecimal::parse_bytes`.
⚠️ Note that range of this type is greater than supported by MySql `DECIMAL` type but it'll be serialized anyway. |
| [`bigdecimal::BigDecimal`] (v0.3.x) | MySql int, uint, floats or bytes parsed using `BigDecimal::parse_bytes`.
⚠️ Note that range of this type is greater than supported by MySql `DECIMAL` type but it'll be serialized anyway. |
| `num_bigint::{BigInt, BigUint}` | MySql int, uint or bytes parsed using `_::parse_bytes`.
⚠️ Note that range of this type is greater than supported by MySql integer types but it'll be serialized anyway (as decimal bytes string). |
Also crate provides from-row convertion for the following list of types (see `FromRow` trait):
| Type | Notes |
| ----------------------------------------------- | ------------------------------------------------- |
| `Row` | Trivial conversion for `Row` itself. |
| `T: FromValue` | For rows with a single column. |
| `(T1: FromValue [, ..., T12: FromValue])` | Row to a tuple of arity 1-12. |
| [`frunk::Hlist!`] types | Usefull to overcome tuple arity limitation |
#### Crate features
| Feature | Description | Default |
| -------------- | ------------------------------------------- | ------- |
| `bigdecimal` | Enables `bigdecimal` v0.2.x types support | 🔴 |
| `bigdecimal03` | Enables `bigdecimal` v0.3.x types support | 🟢 |
| `chrono` | Enables `chrono` types support | 🔴 |
| `rust_decimal` | Enables `rust_decimal` types support | 🟢 |
| `time` | Enables `time` v0.2.x types support | 🔴 |
| `time03` | Enables `time` v0.3.x types support | 🟢 |
| `uuid` | Enables `Uuid` type support | 🟢 |
| `frunk` | Enables `FromRow` for `frunk::Hlist!` types | 🟢 |
[1]: https://dev.mysql.com/doc/internals/en/binary-protocol-value.html
## License
Licensed under either of
* Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
* MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
at your option.
## Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any
additional terms or conditions.