diesel/mysql_like/

mod.rs

//! Provides shared types and functions related to working with MySQL and MariaDB

#[cfg(any(feature = "mysql", feature = "mariadb"))]
mod connection;
mod types;

pub(crate) mod query_builder;
mod value;

use core::hash::Hash;

use crate::backend::{Backend, DieselReserveSpecialization};
use crate::mysql_like::query_builder::MysqlLikeQueryBuilder;
use crate::query_builder::bind_collector::RawBytesBindCollector;
use crate::result::DatabaseErrorKind;
use crate::sql_types::TypeMetadata;

#[cfg(any(feature = "mysql", feature = "mariadb"))]
pub use self::connection::MysqlLikeConnection;
pub use self::value::{MysqlValue, NumericRepresentation};
#[doc(inline)]
pub use sqlstate::mysql_like as sql_state;

/// Data structures for MySQL types which have no corresponding Rust type
///
/// Most of these types are used to implement `ToSql` and `FromSql` for higher
/// level types.
pub mod data_types {
    #[doc(inline)]
    pub use super::types::date_and_time::MysqlTime;
    #[doc(inline)]
    pub use super::types::date_and_time::MysqlTimestampType;
}

/// MySQL specific sql types
pub mod sql_types {
    #[doc(inline)]
    pub use super::types::Datetime;
    #[doc(inline)]
    pub use super::types::Unsigned;
}

/// A trait for backends which implement the MySQL wire protocol. This is implemented for both MySQL and MariaDB,
/// and can be used when writing code that is compatible with both backends.
#[cfg_attr(
    not(feature = "i-implement-a-third-party-backend-and-opt-into-breaking-changes"),
    expect(private_bounds)
)]
pub trait MysqlLikeBackend
where
    Self: for<'a> Backend<
            RawValue<'a> = MysqlValue<'a>,
            BindCollector<'a> = RawBytesBindCollector<Self>,
        >,
    Self: TypeMetadata<TypeMetadata = MysqlType, MetadataLookup = ()>,
    Self: Backend<QueryBuilder = MysqlLikeQueryBuilder<Self>>,
    Self: Hash + Eq + Default,
    Self: DieselReserveSpecialization,
    Self: MapErrorNumber,
    Self: 'static,
{
    #[doc(hidden)]
    /// The scheme used in the connection URL for this backend.
    /// "mysql" for MySQL, "mariadb" for MariaDB.
    const SCHEME: &'static str;
}

#[diesel_derives::__diesel_public_if(
    feature = "i-implement-a-third-party-backend-and-opt-into-breaking-changes"
)]
/// A helper trait to map error numbers to database error kinds for mysql like backends
pub(crate) trait MapErrorNumber {
    /// Resolve the returned error number to a `DatabaseErrorKind`
    // Bound on `MysqlLikeBackend` everywhere, called only by the connections.
    #[cfg_attr(
        not(any(
            feature = "mysql",
            feature = "mariadb",
            feature = "i-implement-a-third-party-backend-and-opt-into-breaking-changes"
        )),
        expect(dead_code, reason = "only the connections call it")
    )]
    fn map_error_number(error_number: u32) -> DatabaseErrorKind;
}

/// Represents possible types, that can be transmitted as via the
/// Mysql wire protocol
#[derive(Debug, Hash, PartialEq, Eq, Clone, Copy)]
#[non_exhaustive]
pub enum MysqlType {
    /// A 8 bit signed integer
    Tiny,
    /// A 8 bit unsigned integer
    UnsignedTiny,
    /// A 16 bit signed integer
    Short,
    /// A 16 bit unsigned integer
    UnsignedShort,
    /// A 32 bit signed integer
    Long,
    /// A 32 bit unsigned integer
    UnsignedLong,
    /// A 64 bit signed integer
    LongLong,
    /// A 64 bit unsigned integer
    UnsignedLongLong,
    /// A 32 bit floating point number
    Float,
    /// A 64 bit floating point number
    Double,
    /// A fixed point decimal value
    Numeric,
    /// A datatype to store a time value
    Time,
    /// A datatype to store a date value
    Date,
    /// A datatype containing timestamp values ranging from
    /// '1000-01-01 00:00:00' to '9999-12-31 23:59:59'.
    DateTime,
    /// A datatype containing timestamp values ranging from
    /// 1970-01-01 00:00:01' UTC to '2038-01-19 03:14:07' UTC.
    Timestamp,
    /// A datatype for string values
    String,
    /// A datatype containing binary large objects
    Blob,
    /// A value containing a set of bit's
    Bit,
    /// A user defined set type
    Set,
    /// A user defined enum type
    Enum,
}

pub(crate) mod query_fragments {
    use crate::backend::sql_dialect::batch_update_support::SupportsBatchUpdate;
    use crate::backend::sql_dialect::on_conflict_clause::SupportsOnConflictClause;

    #[derive(Debug, Clone, Copy)]
    pub struct MysqlStyleDefaultValueClause;

    #[derive(Debug, Clone, Copy)]
    pub struct MysqlConcatClause;

    #[derive(Debug, Clone, Copy)]
    pub struct MysqlOnConflictClause;

    #[derive(Debug, Clone, Copy)]
    pub struct MysqlRequiresOrderForWindowFunctions;

    impl SupportsOnConflictClause for MysqlOnConflictClause {}

    #[derive(Debug, Clone, Copy)]
    pub struct MySqlLikeBatchUpdateSupport;

    impl SupportsBatchUpdate for MySqlLikeBatchUpdateSupport {}
}