diesel 2.4.0

A safe, extensible ORM and Query Builder for PostgreSQL, SQLite, and MySQL
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

use crate::backend::Backend;
use crate::expression::coerce::Coerce;
use crate::expression::functions::declare_sql_function;
use crate::expression::{AsExpression, Expression, ValidGrouping};
use crate::query_builder::*;
use crate::result::QueryResult;
use crate::sql_types::*;

/// Represents the SQL `CURRENT_TIMESTAMP` constant. This is equivalent to the
/// `NOW()` function on backends that support it.
#[allow(non_camel_case_types)]
#[derive(Debug, Copy, Clone, QueryId, ValidGrouping)]
pub struct now;

impl Expression for now {
    type SqlType = Timestamp;
}

impl<DB: Backend> QueryFragment<DB> for now {
    fn walk_ast<'b>(&'b self, mut out: AstPass<'_, 'b, DB>) -> QueryResult<()> {
        out.push_sql("CURRENT_TIMESTAMP");
        Ok(())
    }
}

impl_selectable_expression!(now);

operator_allowed!(now, Add, add);
operator_allowed!(now, Sub, sub);

#[declare_sql_function]
extern "SQL" {
    /// Represents the SQL `DATE` function. The argument should be a Timestamp
    /// expression, and the return value will be an expression of type Date.
    ///
    /// # Examples
    ///
    /// ```
    /// # include!("../../doctest_setup.rs");
    /// # use diesel::dsl::{now, date};
    /// # use diesel::deserialize::Queryable;
    /// #
    /// # fn test<R: Queryable<diesel::sql_types::Date, DB> + 'static>() -> QueryResult<R> {
    /// #     let connection = &mut establish_connection();
    /// let today = diesel::select(date(now)).first(connection)?;
    /// #     Ok(today)
    /// # }
    /// # fn main() {
    /// #
    /// # }
    /// ```
    fn date(expr: Timestamp) -> Date;
}

/// Implements `AsExpression<$sql_type>` for `$expr`, `&$expr` and `&&$expr`, each
/// coercing `$expr` to `$sql_type`.
///
/// The reference impls mirror the `&T` and `&&T` impls that `#[derive(AsExpression)]`
/// generates: `#[derive(AsChangeset)]` on a struct also implements `AsChangeset` for a
/// reference to it, built from references to its fields. Passing a struct by reference
/// to `.set()`, as batch updates do, therefore needs `&now` for a `now` field and
/// `&&now` for a `&now` field.
macro_rules! coerce_as_expression {
    ($expr:ident => $sql_type:ty) => {
        impl AsExpression<$sql_type> for $expr {
            type Expression = Coerce<$expr, $sql_type>;

            fn as_expression(self) -> Self::Expression {
                Coerce::new(self)
            }
        }

        impl AsExpression<$sql_type> for &$expr {
            type Expression = Coerce<$expr, $sql_type>;

            fn as_expression(self) -> Self::Expression {
                Coerce::new(*self)
            }
        }

        impl AsExpression<$sql_type> for &&$expr {
            type Expression = Coerce<$expr, $sql_type>;

            fn as_expression(self) -> Self::Expression {
                Coerce::new(**self)
            }
        }
    };
}

coerce_as_expression!(now => Nullable<Timestamp>);

#[cfg(feature = "postgres_backend")]
coerce_as_expression!(now => Timestamptz);

#[cfg(feature = "postgres_backend")]
coerce_as_expression!(now => Nullable<Timestamptz>);

#[cfg(feature = "__sqlite-shared")]
coerce_as_expression!(now => TimestamptzSqlite);

#[cfg(feature = "__sqlite-shared")]
coerce_as_expression!(now => Nullable<TimestamptzSqlite>);

/// Represents the SQL `CURRENT_DATE` constant.
#[allow(non_camel_case_types)]
#[derive(Debug, Copy, Clone, QueryId, ValidGrouping)]
pub struct today;

impl Expression for today {
    type SqlType = Date;
}

impl<DB: Backend> QueryFragment<DB> for today {
    fn walk_ast<'b>(&'b self, mut out: AstPass<'_, 'b, DB>) -> QueryResult<()> {
        out.push_sql("CURRENT_DATE");
        Ok(())
    }
}

impl_selectable_expression!(today);

operator_allowed!(today, Add, add);
operator_allowed!(today, Sub, sub);

coerce_as_expression!(today => Nullable<Date>);