Skip to main content

ActiveModelTrait

sea_orm::entity

Trait ActiveModelTrait 

Source 
pub trait ActiveModelTrait: Clone + Debug {
    type Entity: EntityTrait;


Show 22 methods    // Required methods
    fn take(
        &mut self,
        c: <Self::Entity as EntityTrait>::Column,
    ) -> ActiveValue<Value>;
    fn get(
        &self,
        c: <Self::Entity as EntityTrait>::Column,
    ) -> ActiveValue<Value>;
    fn set_if_not_equals(
        &mut self,
        c: <Self::Entity as EntityTrait>::Column,
        v: Value,
    );
    fn try_set(
        &mut self,
        c: <Self::Entity as EntityTrait>::Column,
        v: Value,
    ) -> Result<(), DbErr>;
    fn not_set(&mut self, c: <Self::Entity as EntityTrait>::Column);
    fn is_not_set(&self, c: <Self::Entity as EntityTrait>::Column) -> bool;
    fn default() -> Self;
    fn default_values() -> Self;
    fn reset(&mut self, c: <Self::Entity as EntityTrait>::Column);

    // Provided methods
    fn set(&mut self, c: <Self::Entity as EntityTrait>::Column, v: Value) { ... }
    fn reset_all(self) -> Self { ... }
    fn get_primary_key_value(&self) -> Option<ValueTuple> { ... }
    fn insert<'a, C>(
        self,
        db: &'a C,
    ) -> Result<<Self::Entity as EntityTrait>::Model, DbErr>
       where <Self::Entity as EntityTrait>::Model: IntoActiveModel<Self>,
             Self: ActiveModelBehavior,
             C: ConnectionTrait { ... }
    fn update<'a, C>(
        self,
        db: &'a C,
    ) -> Result<<Self::Entity as EntityTrait>::Model, DbErr>
       where <Self::Entity as EntityTrait>::Model: IntoActiveModel<Self>,
             Self: ActiveModelBehavior,
             C: ConnectionTrait { ... }
    fn save<'a, C>(self, db: &'a C) -> Result<Self, DbErr>
       where <Self::Entity as EntityTrait>::Model: IntoActiveModel<Self>,
             Self: ActiveModelBehavior,
             C: ConnectionTrait { ... }
    fn delete<'a, C>(self, db: &'a C) -> Result<DeleteResult, DbErr>
       where Self: ActiveModelBehavior,
             C: ConnectionTrait { ... }
    fn set_from_json(&mut self, json: Value) -> Result<(), DbErr>
       where Self: TryIntoModel<<Self::Entity as EntityTrait>::Model>,
             for<'de> <<Self as ActiveModelTrait>::Entity as EntityTrait>::Model: IntoActiveModel<Self> + Deserialize<'de> + Serialize { ... }
    fn from_json(json: Value) -> Result<Self, DbErr>
       where Self: TryIntoModel<<Self::Entity as EntityTrait>::Model>,
             for<'de> <<Self as ActiveModelTrait>::Entity as EntityTrait>::Model: IntoActiveModel<Self> + Deserialize<'de> + Serialize { ... }
    fn from_arrow(batch: &RecordBatch) -> Result<Vec<Self>, DbErr> { ... }
    fn to_arrow(models: &[Self], schema: &Schema) -> Result<RecordBatch, DbErr> { ... }
    fn is_changed(&self) -> bool { ... }
    fn find_related<R>(&self, _: R) -> Select<R>
       where R: EntityTrait,
             Self::Entity: Related<R> { ... }

}
Expand description

ActiveModel is a type for constructing INSERT and UPDATE statements for a particular table.

Like [Model][ModelTrait], it represents a database record and each field represents a column.

But unlike [Model][ModelTrait], it also stores additional state for every field, and fields are not guaranteed to have a value.

This allows you to:

  • omit columns from the query,
  • know which columns have changed after editing a record.

Required Associated Types§

Source

type Entity: EntityTrait

The Entity this ActiveModel belongs to

Required Methods§

Source

fn take( &mut self, c: <Self::Entity as EntityTrait>::Column, ) -> ActiveValue<Value>

Get a mutable ActiveValue from an ActiveModel

Source

fn get(&self, c: <Self::Entity as EntityTrait>::Column) -> ActiveValue<Value>

Get a immutable ActiveValue from an ActiveModel

Source

fn set_if_not_equals( &mut self, c: <Self::Entity as EntityTrait>::Column, v: Value, )

Set the Value of a ActiveModel field if value is different, panic if failed

Source

fn try_set( &mut self, c: <Self::Entity as EntityTrait>::Column, v: Value, ) -> Result<(), DbErr>

Set the Value of a ActiveModel field, return error if failed

Source

fn not_set(&mut self, c: <Self::Entity as EntityTrait>::Column)

Set the state of an ActiveValue to the not set state

Source

fn is_not_set(&self, c: <Self::Entity as EntityTrait>::Column) -> bool

Check the state of a ActiveValue

Source

fn default() -> Self

Create an ActiveModel with all fields to NotSet

Source

fn default_values() -> Self

Create an ActiveModel with all fields to Set(default_value) if Default is implemented, NotSet otherwise

Source

fn reset(&mut self, c: <Self::Entity as EntityTrait>::Column)

Reset the value from ActiveValue::Unchanged to ActiveValue::Set, leaving ActiveValue::NotSet untouched.

Provided Methods§

Source

fn set(&mut self, c: <Self::Entity as EntityTrait>::Column, v: Value)

Set the Value of a ActiveModel field, panic if failed

Source

fn reset_all(self) -> Self

Reset all values from ActiveValue::Unchanged to ActiveValue::Set, leaving ActiveValue::NotSet untouched.

Source

fn get_primary_key_value(&self) -> Option<ValueTuple>

Get the primary key of the ActiveModel, only if it’s fully specified.

Source

fn insert<'a, C>( self, db: &'a C, ) -> Result<<Self::Entity as EntityTrait>::Model, DbErr>
where <Self::Entity as EntityTrait>::Model: IntoActiveModel<Self>, Self: ActiveModelBehavior, C: ConnectionTrait,

Perform an INSERT operation on the ActiveModel

§Example (Postgres)
use sea_orm::{entity::*, query::*, tests_cfg::cake};

let apple = cake::ActiveModel {
    name: Set("Apple Pie".to_owned()),
    ..Default::default()
};

assert_eq!(
    apple.insert(&db)?,
    cake::Model {
        id: 15,
        name: "Apple Pie".to_owned(),
    }
);

assert_eq!(
    db.into_transaction_log(),
    [Transaction::from_sql_and_values(
        DbBackend::Postgres,
        r#"INSERT INTO "cake" ("name") VALUES ($1) RETURNING "id", "name""#,
        ["Apple Pie".into()]
    )]
);
§Example (MySQL)
use sea_orm::{entity::*, query::*, tests_cfg::cake};

let apple = cake::ActiveModel {
    name: Set("Apple Pie".to_owned()),
    ..Default::default()
};

assert_eq!(
    apple.insert(&db)?,
    cake::Model {
        id: 15,
        name: "Apple Pie".to_owned(),
    }
);

assert_eq!(
    db.into_transaction_log(),
    [
        Transaction::from_sql_and_values(
            DbBackend::MySql,
            r#"INSERT INTO `cake` (`name`) VALUES (?)"#,
            ["Apple Pie".into()]
        ),
        Transaction::from_sql_and_values(
            DbBackend::MySql,
            r#"SELECT `cake`.`id`, `cake`.`name` FROM `cake` WHERE `cake`.`id` = ? LIMIT ?"#,
            [15.into(), 1u64.into()]
        )
    ]
);
Source

fn update<'a, C>( self, db: &'a C, ) -> Result<<Self::Entity as EntityTrait>::Model, DbErr>
where <Self::Entity as EntityTrait>::Model: IntoActiveModel<Self>, Self: ActiveModelBehavior, C: ConnectionTrait,

Perform the UPDATE operation on an ActiveModel

§Example (Postgres)
use sea_orm::{entity::*, query::*, tests_cfg::fruit};

let orange = fruit::ActiveModel {
    id: Set(1),
    name: Set("Orange".to_owned()),
    ..Default::default()
};

assert_eq!(
    orange.update(&db)?,
    fruit::Model {
        id: 1,
        name: "Orange".to_owned(),
        cake_id: None,
    }
);

assert_eq!(
    db.into_transaction_log(),
    [Transaction::from_sql_and_values(
        DbBackend::Postgres,
        r#"UPDATE "fruit" SET "name" = $1 WHERE "fruit"."id" = $2 RETURNING "id", "name", "cake_id""#,
        ["Orange".into(), 1i32.into()]
    )]);
§Example (MySQL)
use sea_orm::{entity::*, query::*, tests_cfg::fruit};

let orange = fruit::ActiveModel {
    id: Set(1),
    name: Set("Orange".to_owned()),
    ..Default::default()
};

assert_eq!(
    orange.update(&db)?,
    fruit::Model {
        id: 1,
        name: "Orange".to_owned(),
        cake_id: None,
    }
);

assert_eq!(
    db.into_transaction_log(),
    [
        Transaction::from_sql_and_values(
            DbBackend::MySql,
            r#"UPDATE `fruit` SET `name` = ? WHERE `fruit`.`id` = ?"#,
            ["Orange".into(), 1i32.into()]
        ),
        Transaction::from_sql_and_values(
            DbBackend::MySql,
            r#"SELECT `fruit`.`id`, `fruit`.`name`, `fruit`.`cake_id` FROM `fruit` WHERE `fruit`.`id` = ? LIMIT ?"#,
            [1i32.into(), 1u64.into()]
        )]);
Source

fn save<'a, C>(self, db: &'a C) -> Result<Self, DbErr>
where <Self::Entity as EntityTrait>::Model: IntoActiveModel<Self>, Self: ActiveModelBehavior, C: ConnectionTrait,

Insert the model if primary key is NotSet, update otherwise. Only works if the entity has auto increment primary key.

Source

fn delete<'a, C>(self, db: &'a C) -> Result<DeleteResult, DbErr>
where Self: ActiveModelBehavior, C: ConnectionTrait,

Delete an active model by its primary key

§Example
use sea_orm::{entity::*, query::*, tests_cfg::fruit};

let orange = fruit::ActiveModel {
    id: Set(3),
    ..Default::default()
};

let delete_result = orange.delete(&db)?;

assert_eq!(delete_result.rows_affected, 1);

assert_eq!(
    db.into_transaction_log(),
    [Transaction::from_sql_and_values(
        DbBackend::Postgres,
        r#"DELETE FROM "fruit" WHERE "fruit"."id" = $1"#,
        [3i32.into()]
    )]
);
Source

fn set_from_json(&mut self, json: Value) -> Result<(), DbErr>
where Self: TryIntoModel<<Self::Entity as EntityTrait>::Model>, for<'de> <<Self as ActiveModelTrait>::Entity as EntityTrait>::Model: IntoActiveModel<Self> + Deserialize<'de> + Serialize,

Available on crate feature with-json only.

Set the corresponding attributes in the ActiveModel from a JSON value

Note that this method will not alter the primary key values in ActiveModel.

Source

fn from_json(json: Value) -> Result<Self, DbErr>
where Self: TryIntoModel<<Self::Entity as EntityTrait>::Model>, for<'de> <<Self as ActiveModelTrait>::Entity as EntityTrait>::Model: IntoActiveModel<Self> + Deserialize<'de> + Serialize,

Available on crate feature with-json only.

Create ActiveModel from a JSON value

Source

fn from_arrow(batch: &RecordBatch) -> Result<Vec<Self>, DbErr>

Available on crate feature with-arrow only.

Create a Vec of ActiveModels from an Arrow RecordBatch.

Each row in the RecordBatch becomes one ActiveModel. Columns are matched by name (using ColumnTrait::as_str). Columns present in the RecordBatch are marked as Set; columns absent from the RecordBatch are marked as NotSet.

Supported column types: integers (i8–i64, u8–u64), floats (f32, f64), String/Text, Boolean, and date/time types (with with-chrono or with-time). Null values in nullable columns are handled.

When both with-chrono and with-time features are enabled, chrono values are attempted first. If the model uses time-crate types, the conversion automatically falls back to the time-crate representation.

Source

fn to_arrow(models: &[Self], schema: &Schema) -> Result<RecordBatch, DbErr>

Available on crate feature with-arrow only.

Convert a slice of ActiveModels into an Arrow RecordBatch.

The schema determines the output columns: each schema field is matched to an entity column by name (using ColumnTrait::as_str). Columns marked Set or Unchanged contribute their value; NotSet columns become null in the output.

Typical usage together with ArrowSchema:

ⓘ
let schema = MyEntity::arrow_schema();
let batch = MyActiveModel::to_arrow(&models, &schema)?;
Source

fn is_changed(&self) -> bool

Return true if any attribute of ActiveModel is Set

Find related Models belonging to self

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors§

Source§

impl ActiveModelTrait for sea_orm::rbac::entity::permission::ActiveModel

Available on crate feature rbac only.
Source§

type Entity = Entity

Source§

impl ActiveModelTrait for sea_orm::rbac::entity::resource::ActiveModel

Available on crate feature rbac only.
Source§

type Entity = Entity

Source§

impl ActiveModelTrait for sea_orm::rbac::entity::role::ActiveModel

Available on crate feature rbac only.
Source§

type Entity = Entity

Source§

impl ActiveModelTrait for sea_orm::rbac::entity::role_hierarchy::ActiveModel

Available on crate feature rbac only.
Source§

type Entity = Entity

Source§

impl ActiveModelTrait for sea_orm::rbac::entity::role_permission::ActiveModel

Available on crate feature rbac only.
Source§

type Entity = Entity

Source§

impl ActiveModelTrait for sea_orm::rbac::entity::user_override::ActiveModel

Available on crate feature rbac only.
Source§

type Entity = Entity

Source§

impl ActiveModelTrait for sea_orm::rbac::entity::user_role::ActiveModel

Available on crate feature rbac only.
Source§

type Entity = Entity