Trait ColumnTrait

pub trait ColumnTrait:
    IdenStatic
    + IntoEnumIterator
    + FromStr {
    type EntityName: EntityName;

Show 34 methods    // Required method
    fn def(&self) -> ColumnDef;

    // Provided methods
    fn enum_type_name(&self) -> Option<&'static str> { ... }
    fn entity_name(&self) -> SeaRc<dyn Iden> { ... }
    fn as_column_ref(&self) -> (SeaRc<dyn Iden>, SeaRc<dyn Iden>) { ... }
    fn eq<V>(&self, v: V) -> SimpleExpr
       where V: Into<Value> { ... }
    fn ne<V>(&self, v: V) -> SimpleExpr
       where V: Into<Value> { ... }
    fn gt<V>(&self, v: V) -> SimpleExpr
       where V: Into<Value> { ... }
    fn gte<V>(&self, v: V) -> SimpleExpr
       where V: Into<Value> { ... }
    fn lt<V>(&self, v: V) -> SimpleExpr
       where V: Into<Value> { ... }
    fn lte<V>(&self, v: V) -> SimpleExpr
       where V: Into<Value> { ... }
    fn between<V>(&self, a: V, b: V) -> SimpleExpr
       where V: Into<Value> { ... }
    fn not_between<V>(&self, a: V, b: V) -> SimpleExpr
       where V: Into<Value> { ... }
    fn like<T>(&self, s: T) -> SimpleExpr
       where T: IntoLikeExpr { ... }
    fn not_like<T>(&self, s: T) -> SimpleExpr
       where T: IntoLikeExpr { ... }
    fn starts_with<T>(&self, s: T) -> SimpleExpr
       where T: Into<String> { ... }
    fn ends_with<T>(&self, s: T) -> SimpleExpr
       where T: Into<String> { ... }
    fn contains<T>(&self, s: T) -> SimpleExpr
       where T: Into<String> { ... }
    fn max(&self) -> SimpleExpr { ... }
    fn min(&self) -> SimpleExpr { ... }
    fn sum(&self) -> SimpleExpr { ... }
    fn count(&self) -> SimpleExpr { ... }
    fn is_null(&self) -> SimpleExpr { ... }
    fn is_not_null(&self) -> SimpleExpr { ... }
    fn if_null<V>(&self, v: V) -> SimpleExpr
       where V: Into<Value> { ... }
    fn is_in<V, I>(&self, v: I) -> SimpleExpr
       where V: Into<Value>,
             I: IntoIterator<Item = V> { ... }
    fn is_not_in<V, I>(&self, v: I) -> SimpleExpr
       where V: Into<Value>,
             I: IntoIterator<Item = V> { ... }
    fn in_subquery(&self, s: SelectStatement) -> SimpleExpr { ... }
    fn not_in_subquery(&self, s: SelectStatement) -> SimpleExpr { ... }
    fn into_expr(self) -> Expr { ... }
    fn into_returning_expr(self, db_backend: DatabaseBackend) -> Expr { ... }
    fn select_as(&self, expr: Expr) -> SimpleExpr { ... }
    fn select_enum_as(&self, expr: Expr) -> SimpleExpr { ... }
    fn save_as(&self, val: Expr) -> SimpleExpr { ... }
    fn save_enum_as(&self, val: Expr) -> SimpleExpr { ... }
}

Expand description

API for working with a Column. Mostly a wrapper of the identically named methods in sea_query::Expr

Required Associated Types§

type EntityName: EntityName

Required Methods§

fn def(&self) -> ColumnDef

Define a column for an Entity

Provided Methods§

fn enum_type_name(&self) -> Option<&'static str>

Get the enum name of the column type

fn entity_name(&self) -> SeaRc<dyn Iden>

Get the name of the entity the column belongs to

fn as_column_ref(&self) -> (SeaRc<dyn Iden>, SeaRc<dyn Iden>)

get the name of the entity the column belongs to

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

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

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

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

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

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

fn between<V>(&self, a: V, b: V) -> SimpleExpr
where V: Into<Value>,

use sea_orm::{entity::*, query::*, tests_cfg::cake, DbBackend};

assert_eq!(
    cake::Entity::find()
        .filter(cake::Column::Id.between(2, 3))
        .build(DbBackend::MySql)
        .to_string(),
    "SELECT `cake`.`id`, `cake`.`name` FROM `cake` WHERE `cake`.`id` BETWEEN 2 AND 3"
);

fn not_between<V>(&self, a: V, b: V) -> SimpleExpr
where V: Into<Value>,

use sea_orm::{entity::*, query::*, tests_cfg::cake, DbBackend};

assert_eq!(
    cake::Entity::find()
        .filter(cake::Column::Id.not_between(2, 3))
        .build(DbBackend::MySql)
        .to_string(),
    "SELECT `cake`.`id`, `cake`.`name` FROM `cake` WHERE `cake`.`id` NOT BETWEEN 2 AND 3"
);

fn like<T>(&self, s: T) -> SimpleExpr
where T: IntoLikeExpr,

use sea_orm::{entity::*, query::*, tests_cfg::cake, DbBackend};

assert_eq!(
    cake::Entity::find()
        .filter(cake::Column::Name.like("cheese"))
        .build(DbBackend::MySql)
        .to_string(),
    "SELECT `cake`.`id`, `cake`.`name` FROM `cake` WHERE `cake`.`name` LIKE 'cheese'"
);

fn not_like<T>(&self, s: T) -> SimpleExpr
where T: IntoLikeExpr,

use sea_orm::{entity::*, query::*, tests_cfg::cake, DbBackend};

assert_eq!(
    cake::Entity::find()
        .filter(cake::Column::Name.not_like("cheese"))
        .build(DbBackend::MySql)
        .to_string(),
    "SELECT `cake`.`id`, `cake`.`name` FROM `cake` WHERE `cake`.`name` NOT LIKE 'cheese'"
);

fn starts_with<T>(&self, s: T) -> SimpleExpr
where T: Into<String>,

This is a simplified shorthand for a more general like method. Use like if you need something more complex, like specifying an escape character.

§Examples

use sea_orm::{entity::*, query::*, tests_cfg::cake, DbBackend};

assert_eq!(
    cake::Entity::find()
        .filter(cake::Column::Name.starts_with("cheese"))
        .build(DbBackend::MySql)
        .to_string(),
    "SELECT `cake`.`id`, `cake`.`name` FROM `cake` WHERE `cake`.`name` LIKE 'cheese%'"
);

fn ends_with<T>(&self, s: T) -> SimpleExpr
where T: Into<String>,

This is a simplified shorthand for a more general like method. Use like if you need something more complex, like specifying an escape character.

§Examples

use sea_orm::{entity::*, query::*, tests_cfg::cake, DbBackend};

assert_eq!(
    cake::Entity::find()
        .filter(cake::Column::Name.ends_with("cheese"))
        .build(DbBackend::MySql)
        .to_string(),
    "SELECT `cake`.`id`, `cake`.`name` FROM `cake` WHERE `cake`.`name` LIKE '%cheese'"
);

fn contains<T>(&self, s: T) -> SimpleExpr
where T: Into<String>,

This is a simplified shorthand for a more general like method. Use like if you need something more complex, like specifying an escape character.