Struct Where 

pub struct Where { /* private fields */ }

A builder for WHERE clauses

Example:

let w = Where::new().eq("name", "admin").and().ge("age", 18);

will generate:

WHERE name = ? AND age >= ?

Implementations

impl Where

pub fn new() -> Self

Create a new Where builder

Example:

let w = Where::new();

pub fn and(self) -> Self

Add AND logic to the WHERE clause

Example:

Where::new().eq("name", "admin").and().eq("age", 18);

will generate:

WHERE name = ? AND age = ?

pub fn or(self) -> Self

Add OR logic to the WHERE clause

Example:

Where::new().eq("name", "admin").or().eq("age", 18);

will generate:

WHERE name = ? OR age = ?

pub fn raw(self, fragment: &str) -> Self

Add a raw SQL fragment to the WHERE clause

Example:

Where::new().raw("name = admin AND age >= 18");

pub fn eq(self, col: &str, value: impl BindArg) -> Self

Add an equality condition(=) to the WHERE clause

Example:

Where::new().eq("name", "admin");

will generate:

WHERE name = ?

pub fn ne(self, col: &str, value: impl BindArg) -> Self

Add a non-equality condition(<>) to the WHERE clause

Example:

Where::new().ne("name", "admin");

will generate:

WHERE name <> ?

pub fn lt(self, col: &str, value: impl BindArg) -> Self

Add a less than condition(<) to the WHERE clause

Example:

Where::new().lt("age", 18);

will generate:

WHERE age < ?

pub fn le(self, col: &str, value: impl BindArg) -> Self

Add a less than or equal to condition(<=) to the WHERE clause

Example:

Where::new().le("age", 18);

will generate:

WHERE age <= ?

pub fn gt(self, col: &str, value: impl BindArg) -> Self

Add a greater than condition(>) to the WHERE clause

Example:

Where::new().gt("age", 18);

will generate:

WHERE age > ?

pub fn ge(self, col: &str, value: impl BindArg) -> Self

Add a greater than or equal to condition(>=) to the WHERE clause

Example:

Where::new().ge("age", 18);

will generate:

WHERE age >= ?

pub fn like(self, col: &str, value: impl BindArg) -> Self

Add a LIKE condition to the WHERE clause

Example:

Where::new().like("name", "%admin%");

will generate:

WHERE name LIKE ?

pub fn is_null(self, col: &str) -> Self

Add a IS NULL condition to the WHERE clause

Example:

Where::new().is_null("status");

will generate:

WHERE status IS NULL

pub fn is_not_null(self, col: &str) -> Self

Add a IS NOT NULL condition to the WHERE clause

Example:

Where::new().is_not_null("status");

will generate:

WHERE status IS NOT NULL

pub fn between(self, col: &str, start: impl BindArg, end: impl BindArg) -> Self

Add a BETWEEN condition to the WHERE clause

Example:

Where::new().between("age", 18, 21);

will generate:

WHERE age BETWEEN ? AND ?

pub fn in<V>(self, col: &str, values: V) -> Self

where V: IntoIterator, V::Item: BindArg,

Add a IN condition to the WHERE clause

Example:

Where::new().r#in("status", vec!["active", "verified", "premium"]);

will generate:

WHERE status IN (?, ?, ?)

pub fn and_group<F>(self, f: F) -> Self

where F: FnOnce(Where) -> Where,

Add a AND group to the WHERE clause

Example:

Where::new().eq("name", "admin").and_group(|w| {
    w.eq("password", "123456").and().ge("age", 21);
});

will generate:

WHERE name = ? AND (password = ? AND age >= ?)

pub fn or_group<F>(self, f: F) -> Self

where F: FnOnce(Where) -> Where,

Add a OR group to the WHERE clause

Example:

Where::new().eq("name", "root").or_group(|w| {
    w.eq("name", "admin").and().ge("age", 21);
});

will generate:

WHERE name = ? AND (age >= ? OR name = ?)

pub fn build(self) -> (String, MySqlArguments)

Build the WHERE clause

Example:

let (sql, args) = Where::new().build();

Trait Implementations

impl Clone for Where

fn clone(&self) -> Where

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Where

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

Formats the value using the given formatter.

impl Default for Where

fn default() -> Where

Returns the “default value” for a type.