pqb 0.1.3

A PostgreSQL Query Builder
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

// Copyright 2025 FastLabs Developers
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use crate::expr::Expr;
use crate::expr::write_expr;
use crate::types::IntoColumnRef;
use crate::writer::SqlWriter;

/// Order expression.
#[derive(Debug, Clone, PartialEq)]
pub struct Order {
    expr: Expr,
    direction: SortDirection,
    nulls: Option<NullOrdering>,
}

#[derive(Debug, Clone, PartialEq)]
enum SortDirection {
    Asc,
    Desc,
}

#[derive(Debug, Clone, PartialEq)]
enum NullOrdering {
    First,
    Last,
}

impl Order {
    /// Order by a column in ascending order.
    pub fn column<T>(col: T) -> Self
    where
        T: IntoColumnRef,
    {
        Self {
            expr: Expr::column(col),
            direction: SortDirection::Asc,
            nulls: None,
        }
    }

    /// Order by an expression in ascending order.
    pub fn expr<E>(expr: E) -> Self
    where
        E: Into<Expr>,
    {
        Self {
            expr: expr.into(),
            direction: SortDirection::Asc,
            nulls: None,
        }
    }

    /// Set the sort direction to ascending.
    pub fn asc(mut self) -> Self {
        self.direction = SortDirection::Asc;
        self
    }

    /// Set the sort direction to descending.
    pub fn desc(mut self) -> Self {
        self.direction = SortDirection::Desc;
        self
    }

    /// Set nulls to appear first.
    pub fn nulls_first(mut self) -> Self {
        self.nulls = Some(NullOrdering::First);
        self
    }

    /// Set nulls to appear last.
    pub fn nulls_last(mut self) -> Self {
        self.nulls = Some(NullOrdering::Last);
        self
    }
}

pub(crate) fn write_order<W: SqlWriter>(w: &mut W, order: &Order) {
    write_expr(w, &order.expr);
    match order.direction {
        SortDirection::Asc => w.push_str(" ASC"),
        SortDirection::Desc => w.push_str(" DESC"),
    }
    if let Some(nulls) = &order.nulls {
        match nulls {
            NullOrdering::First => w.push_str(" NULLS FIRST"),
            NullOrdering::Last => w.push_str(" NULLS LAST"),
        }
    }
}