sea_query/query/ordered.rs
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 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222
use crate::{expr::*, types::*};
pub trait OrderedStatement {
#[doc(hidden)]
// Implementation for the trait.
fn add_order_by(&mut self, order: OrderExpr) -> &mut Self;
/// Clear order expressions
fn clear_order_by(&mut self) -> &mut Self;
/// Order by column.
///
/// # Examples
///
/// Order by ASC and DESC
/// ```
/// use sea_query::{*, tests_cfg::*};
///
/// let query = Query::select()
/// .column(Glyph::Aspect)
/// .from(Glyph::Table)
/// .and_where(Expr::expr(Expr::col(Glyph::Aspect).if_null(0)).gt(2))
/// .order_by(Glyph::Image, Order::Desc)
/// .order_by((Glyph::Table, Glyph::Aspect), Order::Asc)
/// .to_owned();
///
/// assert_eq!(
/// query.to_string(MysqlQueryBuilder),
/// r#"SELECT `aspect` FROM `glyph` WHERE IFNULL(`aspect`, 0) > 2 ORDER BY `image` DESC, `glyph`.`aspect` ASC"#
/// );
/// ```
///
/// Order by custom field ordering
/// ```
/// use sea_query::{tests_cfg::*, *};
///
/// let query = Query::select()
/// .columns([Glyph::Aspect])
/// .from(Glyph::Table)
/// .order_by(
/// Glyph::Id,
/// Order::Field(Values(vec![4.into(), 5.into(), 1.into(), 3.into()])),
/// )
/// .to_owned();
///
/// assert_eq!(
/// query.to_string(MysqlQueryBuilder),
/// [
/// r#"SELECT `aspect`"#,
/// r#"FROM `glyph`"#,
/// r#"ORDER BY CASE"#,
/// r#"WHEN `id`=4 THEN 0"#,
/// r#"WHEN `id`=5 THEN 1"#,
/// r#"WHEN `id`=1 THEN 2"#,
/// r#"WHEN `id`=3 THEN 3"#,
/// r#"ELSE 4 END"#,
/// ]
/// .join(" ")
/// );
///
/// assert_eq!(
/// query.to_string(PostgresQueryBuilder),
/// [
/// r#"SELECT "aspect""#,
/// r#"FROM "glyph""#,
/// r#"ORDER BY CASE"#,
/// r#"WHEN "id"=4 THEN 0"#,
/// r#"WHEN "id"=5 THEN 1"#,
/// r#"WHEN "id"=1 THEN 2"#,
/// r#"WHEN "id"=3 THEN 3"#,
/// r#"ELSE 4 END"#,
/// ]
/// .join(" ")
/// );
///
/// assert_eq!(
/// query.to_string(SqliteQueryBuilder),
/// [
/// r#"SELECT "aspect""#,
/// r#"FROM "glyph""#,
/// r#"ORDER BY CASE"#,
/// r#"WHEN "id"=4 THEN 0"#,
/// r#"WHEN "id"=5 THEN 1"#,
/// r#"WHEN "id"=1 THEN 2"#,
/// r#"WHEN "id"=3 THEN 3"#,
/// r#"ELSE 4 END"#,
/// ]
/// .join(" ")
/// );
/// ```
fn order_by<T>(&mut self, col: T, order: Order) -> &mut Self
where
T: IntoColumnRef,
{
self.add_order_by(OrderExpr {
expr: SimpleExpr::Column(col.into_column_ref()),
order,
nulls: None,
})
}
/// Order by [`SimpleExpr`].
fn order_by_expr(&mut self, expr: SimpleExpr, order: Order) -> &mut Self {
self.add_order_by(OrderExpr {
expr,
order,
nulls: None,
})
}
/// Order by custom string.
fn order_by_customs<I, T>(&mut self, cols: I) -> &mut Self
where
T: ToString,
I: IntoIterator<Item = (T, Order)>,
{
cols.into_iter().for_each(|(c, order)| {
self.add_order_by(OrderExpr {
expr: SimpleExpr::Custom(c.to_string()),
order,
nulls: None,
});
});
self
}
/// Order by vector of columns.
fn order_by_columns<I, T>(&mut self, cols: I) -> &mut Self
where
T: IntoColumnRef,
I: IntoIterator<Item = (T, Order)>,
{
cols.into_iter().for_each(|(c, order)| {
self.add_order_by(OrderExpr {
expr: SimpleExpr::Column(c.into_column_ref()),
order,
nulls: None,
});
});
self
}
/// Order by column with nulls order option.
///
/// # Examples
///
/// ```
/// use sea_query::{*, tests_cfg::*};
///
/// let query = Query::select()
/// .column(Glyph::Aspect)
/// .from(Glyph::Table)
/// .order_by_with_nulls(Glyph::Image, Order::Desc, NullOrdering::Last)
/// .order_by_with_nulls((Glyph::Table, Glyph::Aspect), Order::Asc, NullOrdering::First)
/// .to_owned();
///
/// assert_eq!(
/// query.to_string(PostgresQueryBuilder),
/// r#"SELECT "aspect" FROM "glyph" ORDER BY "image" DESC NULLS LAST, "glyph"."aspect" ASC NULLS FIRST"#
/// );
/// assert_eq!(
/// query.to_string(MysqlQueryBuilder),
/// r#"SELECT `aspect` FROM `glyph` ORDER BY `image` IS NULL ASC, `image` DESC, `glyph`.`aspect` IS NULL DESC, `glyph`.`aspect` ASC"#
/// );
/// ```
fn order_by_with_nulls<T>(&mut self, col: T, order: Order, nulls: NullOrdering) -> &mut Self
where
T: IntoColumnRef,
{
self.add_order_by(OrderExpr {
expr: SimpleExpr::Column(col.into_column_ref()),
order,
nulls: Some(nulls),
})
}
/// Order by [`SimpleExpr`] with nulls order option.
fn order_by_expr_with_nulls(
&mut self,
expr: SimpleExpr,
order: Order,
nulls: NullOrdering,
) -> &mut Self {
self.add_order_by(OrderExpr {
expr,
order,
nulls: Some(nulls),
})
}
/// Order by custom string with nulls order option.
fn order_by_customs_with_nulls<I, T>(&mut self, cols: I) -> &mut Self
where
T: ToString,
I: IntoIterator<Item = (T, Order, NullOrdering)>,
{
cols.into_iter().for_each(|(c, order, nulls)| {
self.add_order_by(OrderExpr {
expr: SimpleExpr::Custom(c.to_string()),
order,
nulls: Some(nulls),
});
});
self
}
/// Order by vector of columns with nulls order option.
fn order_by_columns_with_nulls<I, T>(&mut self, cols: I) -> &mut Self
where
T: IntoColumnRef,
I: IntoIterator<Item = (T, Order, NullOrdering)>,
{
cols.into_iter().for_each(|(c, order, nulls)| {
self.add_order_by(OrderExpr {
expr: SimpleExpr::Column(c.into_column_ref()),
order,
nulls: Some(nulls),
});
});
self
}
}