/
germanubis
/
sqlx
Обзор
Документация
Войти
/
germanubis
/
sqlx
Код
Запросы
0
Задачи
Вики
Пакеты
0
Релизы
0
Аналитика
Безопасность
main
sqlx-mysql/src/types/mod.rs
191 строка
10 KB
Austin Bonander
doc(mysql): document difference between `Uuid` and `uuid::fmt::Hyphenated` (#3580)
29 окт 2024, 02:39
Не верифицирован
29 окт 2024, 02:39
82d332f
Код
Авторство
О чём код?
//! Conversions between Rust and **MySQL/MariaDB** types. //! //! # Types //! //! | Rust type | MySQL/MariaDB type(s) | //! |---------------------------------------|------------------------------------------------------| //! | `bool` | TINYINT(1), BOOLEAN, BOOL (see below) | //! | `i8` | TINYINT | //! | `i16` | SMALLINT | //! | `i32` | INT | //! | `i64` | BIGINT | //! | `u8` | TINYINT UNSIGNED | //! | `u16` | SMALLINT UNSIGNED | //! | `u32` | INT UNSIGNED | //! | `u64` | BIGINT UNSIGNED | //! | `f32` | FLOAT | //! | `f64` | DOUBLE | //! | `&str`, [`String`] | VARCHAR, CHAR, TEXT | //! | `&[u8]`, `Vec<u8>` | VARBINARY, BINARY, BLOB | //! | `IpAddr` | VARCHAR, TEXT | //! | `Ipv4Addr` | INET4 (MariaDB-only), VARCHAR, TEXT | //! | `Ipv6Addr` | INET6 (MariaDB-only), VARCHAR, TEXT | //! | [`MySqlTime`] | TIME (encode and decode full range) | //! | [`Duration`][std::time::Duration] | TIME (for decoding positive values only) | //! //! ##### Note: `BOOLEAN`/`BOOL` Type //! MySQL and MariaDB treat `BOOLEAN` as an alias of the `TINYINT` type: //! //! * [Using Data Types from Other Database Engines (MySQL)](https://dev.mysql.com/doc/refman/8.0/en/other-vendor-data-types.html) //! * [BOOLEAN (MariaDB)](https://mariadb.com/kb/en/boolean/) //! //! For the most part, you can simply use the Rust type `bool` when encoding or decoding a value //! using the dynamic query interface, or passing a boolean as a parameter to the query macros //! (`query!()` _et al._). //! //! However, because the MySQL wire protocol does not distinguish between `TINYINT` and `BOOLEAN`, //! the query macros cannot know that a `TINYINT` column is semantically a boolean. //! By default, they will map a `TINYINT` column as `i8` instead, as that is the safer assumption. //! //! Thus, you must use the type override syntax in the query to tell the macros you are expecting //! a `bool` column. See the docs for `query!()` and `query_as!()` for details on this syntax. //! //! ### NOTE: MySQL's `TIME` type is signed //! MySQL's `TIME` type can be used as either a time-of-day value, or a signed interval. //! Thus, it may take on negative values. //! //! Decoding a [`std::time::Duration`] returns an error if the `TIME` value is negative. //! //! ### [`chrono`](https://crates.io/crates/chrono) //! //! Requires the `chrono` Cargo feature flag. //! //! | Rust type | MySQL/MariaDB type(s) | //! |---------------------------------------|------------------------------------------------------| //! | `chrono::DateTime<Utc>` | TIMESTAMP | //! | `chrono::DateTime<Local>` | TIMESTAMP | //! | `chrono::NaiveDateTime` | DATETIME | //! | `chrono::NaiveDate` | DATE | //! | `chrono::NaiveTime` | TIME (time-of-day only) | //! | `chrono::TimeDelta` | TIME (decodes full range; see note for encoding) | //! //! ### NOTE: MySQL's `TIME` type is dual-purpose //! MySQL's `TIME` type can be used as either a time-of-day value, or an interval. //! However, `chrono::NaiveTime` is designed only to represent a time-of-day. //! //! Decoding a `TIME` value as `chrono::NaiveTime` will return an error if the value is out of range. //! //! The [`MySqlTime`] type supports the full range and it also implements `TryInto<chrono::NaiveTime>`. //! //! Decoding a `chrono::TimeDelta` also supports the full range. //! //! To encode a `chrono::TimeDelta`, convert it to [`MySqlTime`] first using `TryFrom`/`TryInto`. //! //! ### [`time`](https://crates.io/crates/time) //! //! Requires the `time` Cargo feature flag. //! //! | Rust type | MySQL/MariaDB type(s) | //! |---------------------------------------|------------------------------------------------------| //! | `time::PrimitiveDateTime` | DATETIME | //! | `time::OffsetDateTime` | TIMESTAMP | //! | `time::Date` | DATE | //! | `time::Time` | TIME (time-of-day only) | //! | `time::Duration` | TIME (decodes full range; see note for encoding) | //! //! ### NOTE: MySQL's `TIME` type is dual-purpose //! MySQL's `TIME` type can be used as either a time-of-day value, or an interval. //! However, `time::Time` is designed only to represent a time-of-day. //! //! Decoding a `TIME` value as `time::Time` will return an error if the value is out of range. //! //! The [`MySqlTime`] type supports the full range, and it also implements `TryInto<time::Time>`. //! //! Decoding a `time::Duration` also supports the full range. //! //! To encode a `time::Duration`, convert it to [`MySqlTime`] first using `TryFrom`/`TryInto`. //! //! ### [`bigdecimal`](https://crates.io/crates/bigdecimal) //! Requires the `bigdecimal` Cargo feature flag. //! //! | Rust type | MySQL/MariaDB type(s) | //! |---------------------------------------|------------------------------------------------------| //! | `bigdecimal::BigDecimal` | DECIMAL | //! //! ### [`decimal`](https://crates.io/crates/rust_decimal) //! Requires the `decimal` Cargo feature flag. //! //! | Rust type | MySQL/MariaDB type(s) | //! |---------------------------------------|------------------------------------------------------| //! | `rust_decimal::Decimal` | DECIMAL | //! //! ### [`uuid`](https://crates.io/crates/uuid) //! //! Requires the `uuid` Cargo feature flag. //! //! | Rust type | MySQL/MariaDB type(s) | //! |---------------------------------------|------------------------------------------------------| //! | `uuid::Uuid` | BINARY(16) (see note) | //! | `uuid::fmt::Hyphenated` | CHAR(36), VARCHAR, TEXT, UUID (MariaDB-only) | //! | `uuid::fmt::Simple` | CHAR(32), VARCHAR, TEXT | //! //! #### Note: `Uuid` uses binary format //! //! MySQL does not have a native datatype for UUIDs. //! The `UUID()` function returns a 36-character `TEXT` value, //! which encourages storing UUIDs as text. //! //! MariaDB's `UUID` type stores and retrieves as text, though it has a better representation //! for index sorting (see [MariaDB manual: UUID data-type][mariadb-uuid] for details). //! //! As an opinionated library, SQLx chose to map `uuid::Uuid` to/from binary format by default //! (16 bytes, the raw value of a UUID; SQL type `BINARY(16)`). //! This saves 20 bytes over the text format for each value. //! //! The `impl Decode<MySql> for Uuid` does not support the text format, and will return an error. //! //! If you want to use the text format compatible with the `UUID()` function, //! use [`uuid::fmt::Hyphenated`][::uuid::fmt::Hyphenated] in the place of `Uuid`. //! //! The MySQL official blog has an article showing how to support both binary and text format UUIDs //! by storing the binary and adding a generated column for the text format, though this is rather //! verbose and fiddly: <https://dev.mysql.com/blog-archive/storing-uuid-values-in-mysql-tables/> //! //! [mariadb-uuid]: https://mariadb.com/kb/en/uuid-data-type/ //! //! ### [`json`](https://crates.io/crates/serde_json) //! //! Requires the `json` Cargo feature flag. //! //! | Rust type | MySQL/MariaDB type(s) | //! |---------------------------------------|------------------------------------------------------| //! | [`Json<T>`] | JSON | //! | `serde_json::JsonValue` | JSON | //! | `&serde_json::value::RawValue` | JSON | //! //! # Nullable //! //! In addition, `Option<T>` is supported where `T` implements `Type`. An `Option<T>` represents //! a potentially `NULL` value from MySQL/MariaDB. pub(crate) use sqlx_core::types::*; pub use mysql_time::{MySqlTime, MySqlTimeError, MySqlTimeSign}; mod bool; mod bytes; mod float; mod inet; mod int; mod mysql_time; mod str; mod text; mod uint; #[cfg(feature = "json")] mod json; #[cfg(feature = "bigdecimal")] mod bigdecimal; #[cfg(feature = "rust_decimal")] mod rust_decimal; #[cfg(feature = "chrono")] mod chrono; #[cfg(feature = "time")] mod time; #[cfg(feature = "uuid")] mod uuid;