drizzle-core 0.1.12

A type-safe SQL query builder 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

//! `PostgreSQL` sequence functions.
//!
//! These functions interact with `PostgreSQL` sequences (serial/identity columns).

use crate::dialect::DialectTypes;
use crate::sql::SQL;
use crate::traits::SQLParam;
use crate::types::Textual;

use super::{AggOr, AggregateKind, Expr, NonNull, Nullability, SQLExpr, Scalar};

use crate::PostgresDialect;

#[diagnostic::on_unimplemented(
    message = "sequence functions are not available for this dialect",
    label = "sequence functions require PostgreSQL"
)]
pub trait SequenceSupport {}

impl SequenceSupport for PostgresDialect {}

/// NEXTVAL - advances a sequence and returns its new value (`PostgreSQL`).
///
/// The argument is the sequence name as a text expression.
///
/// # Example
///
/// ```rust
/// # let _ = r####"
/// use drizzle_core::expr::nextval;
///
/// // SELECT NEXTVAL('users_id_seq')
/// let next_id = nextval("users_id_seq");
/// # "####;
/// ```
pub fn nextval<'a, V, E>(
    sequence: E,
) -> SQLExpr<'a, V, <V::DialectMarker as DialectTypes>::BigInt, NonNull, Scalar>
where
    V: SQLParam + 'a,
    V::DialectMarker: SequenceSupport,
    E: Expr<'a, V>,
    E::SQLType: Textual,
{
    SQLExpr::new(SQL::func("NEXTVAL", sequence.into_sql()))
}

/// CURRVAL - returns the most recently obtained value from a sequence (`PostgreSQL`).
///
/// Must be called after `NEXTVAL` has been used on the sequence in the current session.
///
/// # Example
///
/// ```rust
/// # let _ = r####"
/// use drizzle_core::expr::currval;
///
/// // SELECT CURRVAL('users_id_seq')
/// let current_id = currval("users_id_seq");
/// # "####;
/// ```
pub fn currval<'a, V, E>(
    sequence: E,
) -> SQLExpr<'a, V, <V::DialectMarker as DialectTypes>::BigInt, NonNull, Scalar>
where
    V: SQLParam + 'a,
    V::DialectMarker: SequenceSupport,
    E: Expr<'a, V>,
    E::SQLType: Textual,
{
    SQLExpr::new(SQL::func("CURRVAL", sequence.into_sql()))
}

/// SETVAL - sets a sequence's current value (`PostgreSQL`).
///
/// # Example
///
/// ```rust
/// # let _ = r####"
/// use drizzle_core::expr::setval;
///
/// // SELECT SETVAL('users_id_seq', 100)
/// let set_id = setval("users_id_seq", 100);
/// # "####;
/// ```
#[allow(clippy::type_complexity)]
pub fn setval<'a, V, E, N>(
    sequence: E,
    value: N,
) -> SQLExpr<
    'a,
    V,
    <V::DialectMarker as DialectTypes>::BigInt,
    <E::Nullable as super::NullOr<N::Nullable>>::Output,
    <E::Aggregate as AggOr<N::Aggregate>>::Output,
>
where
    V: SQLParam + 'a,
    V::DialectMarker: SequenceSupport,
    E: Expr<'a, V>,
    E::SQLType: Textual,
    N: Expr<'a, V>,
    N::SQLType: crate::types::Integral,
    E::Nullable: super::NullOr<N::Nullable>,
    N::Nullable: Nullability,
    E::Aggregate: AggOr<N::Aggregate>,
    N::Aggregate: AggregateKind,
{
    SQLExpr::new(SQL::func(
        "SETVAL",
        sequence
            .into_sql()
            .push(crate::Token::COMMA)
            .append(value.into_sql()),
    ))
}