Skip to main content

Expr

Struct Expr 

Source
pub struct Expr(/* private fields */);
Expand description

Expression builder for creating SQL expressions.

Expr provides static methods to create expressions and instance methods to chain operations on them.

§Example

use reinhardt_query::Expr;

// Simple column reference
let col = Expr::col("name");

// Value expression
let val = Expr::val(42);

// Build complex expressions
let expr = Expr::col("age").gte(18).and(Expr::col("active").eq(true));

Implementations§

Source§

impl Expr

Source

pub fn col<C>(col: C) -> Self
where C: IntoColumnRef,

Create an expression from a column reference.

§Example
use reinhardt_query::expr::Expr;

let expr = Expr::col("name");
Source

pub fn tbl<T, C>(table: T, col: C) -> Self
where T: IntoIden, C: IntoIden,

Create a table-qualified column expression.

§Example
use reinhardt_query::expr::Expr;

let expr = Expr::tbl("users", "name");
Source

pub fn val<V>(val: V) -> Self
where V: IntoValue,

Create a value expression.

§Example
use reinhardt_query::expr::Expr;

let expr = Expr::val(42);
let expr2 = Expr::val("hello");
Source

pub fn cust<S>(sql: S) -> Self
where S: Into<String>,

Create a custom SQL expression.

§Security Warning

DO NOT pass user input directly to this method. This method embeds the SQL string directly into the query without parameterization, which can lead to SQL injection vulnerabilities.

Use Expr::cust_with_values() for dynamic values instead.

§Examples
use reinhardt_query::expr::Expr;

// ✅ SAFE: Static SQL expression
let expr = Expr::cust("NOW()");

// ❌ UNSAFE: User input
// let expr = Expr::cust(&user_input);

// ✅ SAFE: Parameterized custom expression
// let expr = Expr::cust_with_values("? + ?", [user_input, other_value]);
Source

pub fn cust_with_values<S, I, V>(sql: S, values: I) -> Self
where S: Into<String>, I: IntoIterator<Item = V>, V: Into<SimpleExpr>,

Create a custom SQL expression with value placeholders.

Use ? as placeholders for the values.

§Example
use reinhardt_query::expr::Expr;

let expr = Expr::cust_with_values("? + ?", [1, 2]);
Source

pub fn tuple<I>(exprs: I) -> Self
where I: IntoIterator<Item = Self>,

Create a tuple expression.

§Example
use reinhardt_query::expr::Expr;

let expr = Expr::tuple([Expr::val(1), Expr::val(2), Expr::val(3)]);
Source

pub fn asterisk() -> Self

Create an asterisk expression (*).

§Example
use reinhardt_query::expr::Expr;

let expr = Expr::asterisk();
Source

pub fn subquery(select: SelectStatement) -> Self

Create a subquery expression.

This creates a standalone subquery that can be used in FROM or SELECT clauses.

§Example
use reinhardt_query::prelude::*;

let subquery = Query::select().column("id").from("users");
let expr = Expr::subquery(subquery);
Source

pub fn exists(select: SelectStatement) -> Self

Create an EXISTS subquery expression.

§Example
use reinhardt_query::prelude::*;

let subquery = Query::select().column("id").from("orders").and_where(
    Expr::col(("orders", "user_id")).eq(Expr::col(("users", "id")))
);
let exists = Expr::exists(subquery);
Source

pub fn not_exists(select: SelectStatement) -> Self

Create a NOT EXISTS subquery expression.

§Example
use reinhardt_query::prelude::*;

let subquery = Query::select().column("id").from("banned_users").and_where(
    Expr::col(("banned_users", "id")).eq(Expr::col(("users", "id")))
);
let not_exists = Expr::not_exists(subquery);
Source

pub fn in_subquery(self, select: SelectStatement) -> Self

Create an IN subquery expression.

§Example
use reinhardt_query::prelude::*;

let subquery = Query::select().column("user_id").from("premium_users");
let in_expr = Expr::col("id").in_subquery(subquery);
Source

pub fn not_in_subquery(self, select: SelectStatement) -> Self

Create a NOT IN subquery expression.

§Example
use reinhardt_query::prelude::*;

let subquery = Query::select().column("user_id").from("banned_users");
let not_in_expr = Expr::col("id").not_in_subquery(subquery);
Source

pub fn case() -> CaseExprBuilder

Create a CASE expression.

§Example
use reinhardt_query::expr::{Expr, ExprTrait};

let case = Expr::case()
    .when(Expr::col("status").eq("active"), "Active")
    .when(Expr::col("status").eq("pending"), "Pending")
    .else_result("Unknown");
Source

pub fn value<V>(val: V) -> Self
where V: IntoValue,

Create a value expression (alias for Expr::val).

Source

pub fn expr_col(col: DynIden) -> Self

Create an expression from a DynIden column.

Source

pub fn null() -> Self

Create a NULL constant expression.

Source

pub fn constant_true() -> Self

Create a TRUE constant expression.

Source

pub fn constant_false() -> Self

Create a FALSE constant expression.

Source

pub fn default() -> Self

Create a DEFAULT constant expression.

Source

pub fn current_timestamp() -> Self

Create a CURRENT_TIMESTAMP expression.

Source

pub fn current_date() -> Self

Create a CURRENT_DATE expression.

Source

pub fn current_time() -> Self

Create a CURRENT_TIME expression.

Source

pub fn over(self, window: WindowStatement) -> SimpleExpr

Apply a window specification to this expression.

This creates a window function call with an inline window specification.

§Examples
use reinhardt_query::prelude::*;
use reinhardt_query::types::window::WindowStatement;

let window = WindowStatement {
    partition_by: vec![Expr::col("department_id").into_simple_expr()],
    order_by: vec![],
    frame: None,
};

let expr = Expr::row_number().over(window);
Source

pub fn over_named<T: IntoIden>(self, name: T) -> SimpleExpr

Apply a named window to this expression.

This creates a window function call that references a named window defined in the WINDOW clause.

§Examples
use reinhardt_query::prelude::*;

let expr = Expr::row_number().over_named("w");
Source

pub fn row_number() -> Self

Create a ROW_NUMBER() window function.

Returns a sequential number for each row within a partition.

§Examples
use reinhardt_query::prelude::*;
use reinhardt_query::types::window::WindowStatement;

let window = WindowStatement {
    partition_by: vec![],
    order_by: vec![],
    frame: None,
};

let expr = Expr::row_number().over(window);
Source

pub fn rank() -> Self

Create a RANK() window function.

Returns the rank of each row within a partition, with gaps in ranking for tied values.

§Examples
use reinhardt_query::prelude::*;
use reinhardt_query::types::window::WindowStatement;

let window = WindowStatement {
    partition_by: vec![],
    order_by: vec![],
    frame: None,
};

let expr = Expr::rank().over(window);
Source

pub fn dense_rank() -> Self

Create a DENSE_RANK() window function.

Returns the rank of each row within a partition, without gaps in ranking for tied values.

§Examples
use reinhardt_query::prelude::*;
use reinhardt_query::types::window::WindowStatement;

let window = WindowStatement {
    partition_by: vec![],
    order_by: vec![],
    frame: None,
};

let expr = Expr::dense_rank().over(window);
Source

pub fn ntile(buckets: i64) -> Self

Create an NTILE(n) window function.

Divides the rows in a partition into buckets number of groups.

§Examples
use reinhardt_query::prelude::*;
use reinhardt_query::types::window::WindowStatement;

let window = WindowStatement {
    partition_by: vec![],
    order_by: vec![],
    frame: None,
};

let expr = Expr::ntile(4).over(window); // Divide into quartiles
Source

pub fn lead( expr: SimpleExpr, offset: Option<i64>, default: Option<Value>, ) -> Self

Create a LEAD() window function.

Returns the value of the expression evaluated at the row that is offset rows after the current row within the partition.

§Arguments
  • expr - The expression to evaluate
  • offset - Number of rows after the current row (default is 1 if None)
  • default - Default value if the lead row doesn’t exist (default is NULL if None)
§Examples
use reinhardt_query::prelude::*;
use reinhardt_query::types::window::WindowStatement;

let window = WindowStatement {
    partition_by: vec![],
    order_by: vec![],
    frame: None,
};

// Get next salary value
let expr = Expr::lead(Expr::col("salary").into_simple_expr(), Some(1), None).over(window);
Source

pub fn lag( expr: SimpleExpr, offset: Option<i64>, default: Option<Value>, ) -> Self

Create a LAG() window function.

Returns the value of the expression evaluated at the row that is offset rows before the current row within the partition.

§Arguments
  • expr - The expression to evaluate
  • offset - Number of rows before the current row (default is 1 if None)
  • default - Default value if the lag row doesn’t exist (default is NULL if None)
§Examples
use reinhardt_query::prelude::*;
use reinhardt_query::types::window::WindowStatement;

let window = WindowStatement {
    partition_by: vec![],
    order_by: vec![],
    frame: None,
};

// Get previous salary value
let expr = Expr::lag(Expr::col("salary").into_simple_expr(), Some(1), None).over(window);
Source

pub fn first_value(expr: SimpleExpr) -> Self

Create a FIRST_VALUE() window function.

Returns the first value in a window frame.

§Examples
use reinhardt_query::prelude::*;
use reinhardt_query::types::window::WindowStatement;

let window = WindowStatement {
    partition_by: vec![],
    order_by: vec![],
    frame: None,
};

let expr = Expr::first_value(Expr::col("salary").into_simple_expr()).over(window);
Source

pub fn last_value(expr: SimpleExpr) -> Self

Create a LAST_VALUE() window function.

Returns the last value in a window frame.

§Examples
use reinhardt_query::prelude::*;
use reinhardt_query::types::window::WindowStatement;

let window = WindowStatement {
    partition_by: vec![],
    order_by: vec![],
    frame: None,
};

let expr = Expr::last_value(Expr::col("salary").into_simple_expr()).over(window);
Source

pub fn nth_value(expr: SimpleExpr, n: i64) -> Self

Create an NTH_VALUE() window function.

Returns the value of the expression at the nth row of the window frame.

§Arguments
  • expr - The expression to evaluate
  • n - The row number (1-based) within the frame
§Examples
use reinhardt_query::prelude::*;
use reinhardt_query::types::window::WindowStatement;

let window = WindowStatement {
    partition_by: vec![],
    order_by: vec![],
    frame: None,
};

// Get the 3rd salary value in the frame
let expr = Expr::nth_value(Expr::col("salary").into_simple_expr(), 3).over(window);
Source

pub fn into_simple_expr(self) -> SimpleExpr

Convert this Expr into a SimpleExpr.

Source

pub fn as_simple_expr(&self) -> &SimpleExpr

Get a reference to the underlying SimpleExpr.

Source

pub fn binary<R>(self, op: BinOper, right: R) -> SimpleExpr
where R: Into<SimpleExpr>,

Create a binary operation expression.

§Example
use reinhardt_query::prelude::*;

let expr = Expr::col("age").binary(BinOper::GreaterThan, Expr::val(18).into_simple_expr());
Source

pub fn equals<C>(self, col: C) -> SimpleExpr
where C: IntoColumnRef,

Create an equality expression between two columns.

This is equivalent to self.eq(Expr::col(col)).

§Example
use reinhardt_query::prelude::*;

let expr = Expr::col(("orders", "user_id")).equals(("users", "id"));
Source

pub fn expr_as<T: IntoIden>(self, alias: T) -> SimpleExpr

Create an aliased expression (AS).

§Example
use reinhardt_query::expr::Expr;

let expr = Expr::col("name").expr_as("alias_name");

Trait Implementations§

Source§

impl Clone for Expr

Source§

fn clone(&self) -> Expr

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Expr

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl ExprTrait for Expr

Source§

fn into_simple_expr(self) -> SimpleExpr

Build the final SimpleExpr.
Source§

fn eq<V>(self, v: V) -> SimpleExpr
where V: Into<SimpleExpr>,

Equal (=). Read more
Source§

fn ne<V>(self, v: V) -> SimpleExpr
where V: Into<SimpleExpr>,

Not equal (<>).
Source§

fn lt<V>(self, v: V) -> SimpleExpr
where V: Into<SimpleExpr>,

Less than (<).
Source§

fn lte<V>(self, v: V) -> SimpleExpr
where V: Into<SimpleExpr>,

Less than or equal (<=).
Source§

fn gt<V>(self, v: V) -> SimpleExpr
where V: Into<SimpleExpr>,

Greater than (>).
Source§

fn gte<V>(self, v: V) -> SimpleExpr
where V: Into<SimpleExpr>,

Greater than or equal (>=).
Source§

fn is_null(self) -> SimpleExpr

IS NULL.
Source§

fn is_not_null(self) -> SimpleExpr

IS NOT NULL.
Source§

fn between<A, B>(self, a: A, b: B) -> SimpleExpr
where A: Into<SimpleExpr>, B: Into<SimpleExpr>,

BETWEEN. Read more
Source§

fn not_between<A, B>(self, a: A, b: B) -> SimpleExpr
where A: Into<SimpleExpr>, B: Into<SimpleExpr>,

NOT BETWEEN.
Source§

fn is_in<I, V>(self, values: I) -> SimpleExpr
where I: IntoIterator<Item = V>, V: Into<SimpleExpr>,

Source§

fn is_not_in<I, V>(self, values: I) -> SimpleExpr
where I: IntoIterator<Item = V>, V: Into<SimpleExpr>,

NOT IN.
Source§

fn like<V>(self, pattern: V) -> SimpleExpr
where V: Into<SimpleExpr>,

LIKE. Read more
Source§

fn not_like<V>(self, pattern: V) -> SimpleExpr
where V: Into<SimpleExpr>,

NOT LIKE.
Source§

fn ilike<V>(self, pattern: V) -> SimpleExpr
where V: Into<SimpleExpr>,

ILIKE (case-insensitive LIKE, PostgreSQL).
Source§

fn not_ilike<V>(self, pattern: V) -> SimpleExpr
where V: Into<SimpleExpr>,

NOT ILIKE (PostgreSQL).
Source§

fn starts_with<S>(self, prefix: S) -> SimpleExpr
where S: Into<String>,

Helper for LIKE with prefix wildcard.
Source§

fn ends_with<S>(self, suffix: S) -> SimpleExpr
where S: Into<String>,

Helper for LIKE with suffix wildcard.
Source§

fn contains<S>(self, substring: S) -> SimpleExpr
where S: Into<String>,

Helper for LIKE with both wildcards.
Source§

fn and<E>(self, other: E) -> SimpleExpr
where E: Into<SimpleExpr>,

AND.
Source§

fn or<E>(self, other: E) -> SimpleExpr
where E: Into<SimpleExpr>,

OR.
Source§

fn not(self) -> SimpleExpr

NOT (unary).
Source§

fn add<V>(self, v: V) -> SimpleExpr
where V: Into<SimpleExpr>,

Addition (+).
Source§

fn sub<V>(self, v: V) -> SimpleExpr
where V: Into<SimpleExpr>,

Subtraction (-).
Source§

fn mul<V>(self, v: V) -> SimpleExpr
where V: Into<SimpleExpr>,

Multiplication (*).
Source§

fn div<V>(self, v: V) -> SimpleExpr
where V: Into<SimpleExpr>,

Division (/).
Source§

fn modulo<V>(self, v: V) -> SimpleExpr
where V: Into<SimpleExpr>,

Modulo (%).
Source§

fn bit_and<V>(self, v: V) -> SimpleExpr
where V: Into<SimpleExpr>,

Bitwise AND (&).
Source§

fn bit_or<V>(self, v: V) -> SimpleExpr
where V: Into<SimpleExpr>,

Bitwise OR (|).
Source§

fn left_shift<V>(self, v: V) -> SimpleExpr
where V: Into<SimpleExpr>,

Left shift (<<).
Source§

fn right_shift<V>(self, v: V) -> SimpleExpr
where V: Into<SimpleExpr>,

Right shift (>>).
Source§

fn cast_as<T>(self, type_name: T) -> SimpleExpr
where T: IntoIden,

CAST expression. Read more
Source§

fn as_enum<T>(self, type_name: T) -> SimpleExpr
where T: IntoIden,

AS ENUM expression (PostgreSQL).
Source§

impl From<&str> for Expr

Source§

fn from(s: &str) -> Self

Converts to this type from the input type.
Source§

impl From<Expr> for SimpleExpr

Source§

fn from(e: Expr) -> Self

Converts to this type from the input type.
Source§

impl From<SimpleExpr> for Expr

Source§

fn from(e: SimpleExpr) -> Self

Converts to this type from the input type.
Source§

impl IntoCondition for Expr

Source§

fn into_condition_expression(self) -> ConditionExpression

Convert into a ConditionExpression.
Source§

fn into_condition(self) -> Condition
where Self: Sized,

Convert into a Condition (wrapping if necessary).
Source§

impl IntoValue for Expr

Source§

fn into_value(self) -> Value

Converts this value into a Value.

Auto Trait Implementations§

§

impl Freeze for Expr

§

impl !RefUnwindSafe for Expr

§

impl !Send for Expr

§

impl !Sync for Expr

§

impl Unpin for Expr

§

impl UnsafeUnpin for Expr

§

impl !UnwindSafe for Expr

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.