sea-orm 2.0.0-rc.41

🐚 An async & dynamic ORM for Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136

use crate::{QueryTrait, Statement, database::*};

/// Glue type used by the [`debug_query!`](crate::debug_query) /
/// [`debug_query_stmt!`](crate::debug_query_stmt) macros to render a query
/// for a specific backend or connection. Most code should use those macros
/// rather than naming this type directly.
#[derive(Debug)]
pub struct DebugQuery<'a, Q, T> {
    /// The query to render.
    pub query: &'a Q,
    /// Either a [`DbBackend`] or a connection to take the backend from.
    pub value: T,
}

macro_rules! debug_query_build {
    ($impl_obj:ty, $db_expr:expr) => {
        impl<'a, Q> DebugQuery<'a, Q, $impl_obj>
        where
            Q: QueryTrait,
        {
            /// This macro builds a [Statement] when invoked
            pub fn build(&self) -> Statement {
                let func = $db_expr;
                let db_backend = func(self);
                self.query.build(db_backend)
            }
        }
    };
}

debug_query_build!(DbBackend, |x: &DebugQuery<_, DbBackend>| x.value);
debug_query_build!(&DbBackend, |x: &DebugQuery<_, &DbBackend>| *x.value);
debug_query_build!(DatabaseConnection, |x: &DebugQuery<
    _,
    DatabaseConnection,
>| x.value.get_database_backend());
debug_query_build!(&DatabaseConnection, |x: &DebugQuery<
    _,
    &DatabaseConnection,
>| x.value.get_database_backend());

/// Helper to get a `Statement` from an object that impl `QueryTrait`.
///
/// # Example
///
/// ```
/// # #[cfg(feature = "mock")]
/// # use sea_orm::{error::*, tests_cfg::*, MockDatabase, MockExecResult, DbBackend};
/// #
/// # let conn = MockDatabase::new(DbBackend::Postgres)
/// #     .into_connection();
/// #
/// use sea_orm::{debug_query_stmt, entity::*, query::*, tests_cfg::cake};
///
/// let c = cake::Entity::insert(cake::ActiveModel {
///     id: ActiveValue::set(1),
///     name: ActiveValue::set("Apple Pie".to_owned()),
/// });
///
/// let raw_sql = debug_query_stmt!(&c, &conn).to_string();
/// assert_eq!(
///     raw_sql,
///     r#"INSERT INTO "cake" ("id", "name") VALUES (1, 'Apple Pie')"#
/// );
///
/// let raw_sql = debug_query_stmt!(&c, conn).to_string();
/// assert_eq!(
///     raw_sql,
///     r#"INSERT INTO "cake" ("id", "name") VALUES (1, 'Apple Pie')"#
/// );
///
/// let raw_sql = debug_query_stmt!(&c, DbBackend::MySql).to_string();
/// assert_eq!(
///     raw_sql,
///     r#"INSERT INTO `cake` (`id`, `name`) VALUES (1, 'Apple Pie')"#
/// );
///
/// let raw_sql = debug_query_stmt!(&c, &DbBackend::MySql).to_string();
/// assert_eq!(
///     raw_sql,
///     r#"INSERT INTO `cake` (`id`, `name`) VALUES (1, 'Apple Pie')"#
/// );
/// ```
#[macro_export]
macro_rules! debug_query_stmt {
    ($query:expr,$value:expr) => {
        $crate::DebugQuery {
            query: $query,
            value: $value,
        }
        .build();
    };
}

/// Helper to get a raw SQL string from an object that impl `QueryTrait`.
///
/// # Example
///
/// ```
/// # #[cfg(feature = "mock")]
/// # use sea_orm::{error::*, tests_cfg::*, MockDatabase, MockExecResult, DbBackend};
/// #
/// # let conn = MockDatabase::new(DbBackend::Postgres)
/// #     .into_connection();
/// #
/// use sea_orm::{debug_query, entity::*, query::*, tests_cfg::cake};
///
/// let c = cake::Entity::insert(cake::ActiveModel {
///     id: ActiveValue::set(1),
///     name: ActiveValue::set("Apple Pie".to_owned()),
/// });
///
/// let raw_sql = debug_query!(&c, &conn);
/// assert_eq!(
///     raw_sql,
///     r#"INSERT INTO "cake" ("id", "name") VALUES (1, 'Apple Pie')"#
/// );
///
/// let raw_sql = debug_query!(&c, conn);
/// assert_eq!(
///     raw_sql,
///     r#"INSERT INTO "cake" ("id", "name") VALUES (1, 'Apple Pie')"#
/// );
///
/// let raw_sql = debug_query!(&c, DbBackend::Sqlite);
/// assert_eq!(
///     raw_sql,
///     r#"INSERT INTO "cake" ("id", "name") VALUES (1, 'Apple Pie')"#
/// );
/// ```
#[macro_export]
macro_rules! debug_query {
    ($query:expr,$value:expr) => {
        $crate::debug_query_stmt!($query, $value).to_string();
    };
}