auto set timestamp column when update & insert #854

liberwang1013 · 2022-07-09T10:39:36Z

PR Info

Closes Automatically update created_at & updated_at timestamp columns on update #827

Adds

add created_at & updated_at attributes support when define model

More Details

In this implement, the timestamp column type should be defined as TIMESTAMP or TIMESTAMPTZ, so the Model must be defined line below

#[derive(Clone, Debug, PartialEq, DeriveEntityModel)]
#[sea_orm(table_name = "cake")]
pub struct Model {
    #[sea_orm(primary_key)]
    pub id: i64,
    #[sea_orm(default_value = "Sam")]
    pub name: String,
    #[sea_orm(created_at, column_type = "TimestampWithTimeZone")]
    pub created_at: DateTimeWithTimeZone,
    #[sea_orm(updated_at, column_type = "Timestamp")]
    pub updated_at: DateTime
}

sea-orm-macros/src/derives/entity_model.rs

billy1624

Hey @liberwang1013, sorry for the delay. Thanks for the contributions!!

I have added some test cases, refactored a few places as well. Please review and then cherrypick :)

liberwang1013/sea-orm@auto-update-timestamp-column...billy1624:pr/854

liberwang1013 · 2022-08-03T17:04:31Z

Hey @liberwang1013, sorry for the delay. Thanks for the contributions!!

I have added some test cases, refactored a few places as well. Please review and then cherrypick :)
* [liberwang1013/sea-orm@auto-update-timestamp-column...billy1624:pr/854](https://github.com/liberwang1013/sea-orm/compare/auto-update-timestamp-column...billy1624:pr/854)

Hi @billy1624 , thank you for your commit. I have already cherrypicked your commit, your commit is great. But, now we have to face a new problem that we didn't pass all checks. I have searched some documents try to figure out what's the problem . In this case, it seems that default value the system given is conflicted with msyql default sql_mode setttings.

CREATE TABLE `check` (
  `id` int NOT NULL AUTO_INCREMENT PRIMARY KEY,
  `pay` varchar(255) NOT NULL,
  `amount` double NOT NULL,
  `updated_at` timestamp NOT NULL,
  `created_at` timestamp NOT NULL
)

I think there are three ways to fix it

remove the NOT NULL constrain for updated_at & created_at columns
give the default value CURRENT_TIMESTAMP for updated_at & created_at columns
disable NO_ZERO_DATE sql mode in this case

what's your opinion?

tyt2y3 · 2022-08-07T10:02:58Z

Yes, actually if you want a robust timestamps, the best way is to rely on DB's native DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP. And I think we need better SeaQuery support for this

billy1624 · 2022-08-10T10:32:31Z

Yes, actually if you want a robust timestamps, the best way is to rely on DB's native DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP. And I think we need better SeaQuery support for this

Note that not all database support such ON UPDATE CURRENT_TIMESTAMP syntax. For example, PostgreSQL doesn't have it. Instead, a trigger is needed to perform the operation. See https://stackoverflow.com/a/1036010/7059723

billy1624 · 2022-08-10T10:51:58Z

Okay, we have two problems here

Define timestamp column with default value of CURRENT_TIMESTAMP

#[derive(Clone, Debug, PartialEq, DeriveEntityModel)]
#[sea_orm(table_name = "check")]
pub struct Model {
    ...
    #[sea_orm(updated_at, default_expr = "Func::current_timestamp()")]
    pub updated_at: DateTimeWithTimeZone,
    #[sea_orm(created_at, default_expr = "Func::current_timestamp()")]
    pub created_at: DateTimeWithTimeZone,
}

Also, we could provide a shorthand for it

#[derive(Clone, Debug, PartialEq, DeriveEntityModel)]
#[sea_orm(table_name = "check")]
pub struct Model {
    ...
    #[sea_orm(updated_at, default_current_timestamp)]
    pub updated_at: DateTimeWithTimeZone,
    #[sea_orm(created_at, default_current_timestamp)]
    pub created_at: DateTimeWithTimeZone,
}

Related issues:

Table Column with Default Expression sea-query#347

Provide db specific way to set ON UPDATE CURRENT_TIMESTAMP

For example,

MySQL: https://dev.mysql.com/doc/refman/8.0/en/timestamp-initialization.html
PostgreSQL: https://stackoverflow.com/a/1036010/7059723
SQLite: No easy way to achieve it except https://stackoverflow.com/q/6578439/7059723

Related issues:

Add support for Postgresql's function and trigger sea-query#403

liberwang1013 · 2022-08-20T04:31:16Z

#[derive(Clone, Debug, PartialEq, DeriveEntityModel)]
#[sea_orm(table_name = "check")]
pub struct Model {
    ...
    #[sea_orm(updated_at, default_expr = "Func::current_timestamp()")]
    pub updated_at: DateTimeWithTimeZone,
    #[sea_orm(created_at, default_expr = "Func::current_timestamp()")]
    pub created_at: DateTimeWithTimeZone,
}

In this way, I prefer using CURRENT_TIMESTAMP directly. In some cases, the developer can use some sea-orm still unsupported expresssion such as Generated Columns features.

liberwang1013 · 2022-08-20T07:16:20Z

Okay, we have two problems here

1. Define timestamp column with default value of `CURRENT_TIMESTAMP`

#[derive(Clone, Debug, PartialEq, DeriveEntityModel)]
#[sea_orm(table_name = "check")]
pub struct Model {
    ...
    #[sea_orm(updated_at, default_expr = "Func::current_timestamp()")]
    pub updated_at: DateTimeWithTimeZone,
    #[sea_orm(created_at, default_expr = "Func::current_timestamp()")]
    pub created_at: DateTimeWithTimeZone,
}

Also, we could provide a shorthand for it

#[derive(Clone, Debug, PartialEq, DeriveEntityModel)]
#[sea_orm(table_name = "check")]
pub struct Model {
    ...
    #[sea_orm(updated_at, default_current_timestamp)]
    pub updated_at: DateTimeWithTimeZone,
    #[sea_orm(created_at, default_current_timestamp)]
    pub created_at: DateTimeWithTimeZone,
}

Related issues:

* [Table Column with Default Expression sea-query#347](https://github.com/SeaQL/sea-query/issues/347)


2. Provide db specific way to set `ON UPDATE CURRENT_TIMESTAMP`

For example,

* MySQL: https://dev.mysql.com/doc/refman/8.0/en/timestamp-initialization.html

* PostgreSQL: https://stackoverflow.com/a/1036010/7059723

* SQLite: No easy way to achieve it except https://stackoverflow.com/q/6578439/7059723

Related issues:

* [Add support for Postgresql's function and trigger sea-query#403](https://github.com/SeaQL/sea-query/issues/403)

I think I have found a better way to do this: support extra macro attribute.

billy1624 · 2022-08-24T10:22:40Z

I think I have found a better way to do this: support extra macro attribute.

I'd say the extra attribute is good to have and it serve as a temporary workaround before default expression land. :)

billy1624

Thanks!! @liberwang1013

tyt2y3 · 2023-01-19T07:29:07Z

https://docs.rs/sea-query/latest/sea_query/table/struct.ColumnDef.html#method.default in SeaQuery now also accpets an Expr so we can now write:

let table = Table::create()
    .table(Char::Table)
    .col(ColumnDef::new(Char::FontId).integer().default(12i32))
    .col(
        ColumnDef::new(Char::CreatedAt)
            .timestamp()
            .default(Expr::current_timestamp())
            .not_null(),
    )
    .to_owned();

assert_eq!(
    table.to_string(MysqlQueryBuilder),
    [
        "CREATE TABLE `character` (",
        "`font_id` int DEFAULT 12,",
        "`created_at` timestamp DEFAULT CURRENT_TIMESTAMP NOT NULL",
        ")",
    ]
    .join(" ")
);

…at in update statement

…ted_at column

billy1624 · 2023-01-30T10:52:39Z

src/schema/entity.rs

+    if let Some(value) = orm_column_def.extra {
+        column_def.default(value);
+    }


Found a typo

Suggested change

if let Some(value) = orm_column_def.extra {

column_def.default(value);

}

if let Some(value) = orm_column_def.extra {

column_def.extra(value);

}

Hi @billy1624 thanks for your comment,
what about replaced with column_def.default(SimpleExpr::CustomWithExpr(value, vec![]));, I found the generated default expr in schema is going to quoted with ' in this(column_def.default(value);) way.

billy1624 · 2023-01-30T11:12:20Z

Hey @liberwang1013, please check liberwang1013#6

…/sea_query/table/struct.ColumnDef.html\#method.default

liberwang1013 · 2023-01-30T13:26:28Z

https://docs.rs/sea-query/latest/sea_query/table/struct.ColumnDef.html#method.default in SeaQuery now also accpets an Expr so we can now write:

let table = Table::create()
    .table(Char::Table)
    .col(ColumnDef::new(Char::FontId).integer().default(12i32))
    .col(
        ColumnDef::new(Char::CreatedAt)
            .timestamp()
            .default(Expr::current_timestamp())
            .not_null(),
    )
    .to_owned();

assert_eq!(
    table.to_string(MysqlQueryBuilder),
    [
        "CREATE TABLE `character` (",
        "`font_id` int DEFAULT 12,",
        "`created_at` timestamp DEFAULT CURRENT_TIMESTAMP NOT NULL",
        ")",
    ]
    .join(" ")
);

hi @tyt2y3 , the code has been updated, please review it.

tyt2y3 · 2023-01-31T06:24:02Z

Sorry but this will not be released on 0.11

sutt0n · 2024-01-31T12:54:07Z

Any updates on this functionality getting in, or has something else similar made its way into the crate?

carlocorradini · 2024-05-12T12:15:40Z

Any update? 🤯
This is super useful ☺️

billy1624 assigned liberwang1013 Jul 12, 2022

penso reviewed Jul 19, 2022

View reviewed changes

sea-orm-macros/src/derives/entity_model.rs Show resolved Hide resolved

billy1624 reviewed Aug 3, 2022

View reviewed changes

liberwang1013 force-pushed the auto-update-timestamp-column branch from 2869439 to d9d77dc Compare August 8, 2022 16:00

liberwang1013 force-pushed the auto-update-timestamp-column branch 3 times, most recently from 7df929b to 37de813 Compare August 20, 2022 08:28

billy1624 approved these changes Aug 24, 2022

View reviewed changes

billy1624 mentioned this pull request Sep 1, 2022

Invalid default value for 'updated_at' #994

Closed

Liber Wang and others added 5 commits January 30, 2023 17:51

auto set created_at & updated_at in insert statement and set updated_…

be624c6

…at in update statement

try using sql function to get timestamp

516928d

Refactoring and test cases added

2834847

fix test case error: remove not null constraint for created_at & upda…

d6afa09

…ted_at column

support extra in entity macro field

fa4b65d

liberwang1013 force-pushed the auto-update-timestamp-column branch from 37de813 to fa4b65d Compare January 30, 2023 10:43

billy1624 reviewed Jan 30, 2023

View reviewed changes

remove extra function, replaced with https://docs.rs/sea-query/latest…

fbe88a4

…/sea_query/table/struct.ColumnDef.html\#method.default

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

auto set timestamp column when update & insert #854

auto set timestamp column when update & insert #854

liberwang1013 commented Jul 9, 2022 •

edited

Loading

billy1624 left a comment

liberwang1013 commented Aug 3, 2022

tyt2y3 commented Aug 7, 2022

billy1624 commented Aug 10, 2022

billy1624 commented Aug 10, 2022 •

edited

Loading

liberwang1013 commented Aug 20, 2022

liberwang1013 commented Aug 20, 2022

billy1624 commented Aug 24, 2022

billy1624 left a comment

tyt2y3 commented Jan 19, 2023 •

edited

Loading

billy1624 Jan 30, 2023

liberwang1013 Jan 30, 2023 •

edited

Loading

billy1624 commented Jan 30, 2023

liberwang1013 commented Jan 30, 2023

tyt2y3 commented Jan 31, 2023 •

edited

Loading

sutt0n commented Jan 31, 2024

carlocorradini commented May 12, 2024

auto set timestamp column when update & insert #854

Are you sure you want to change the base?

auto set timestamp column when update & insert #854

Conversation

liberwang1013 commented Jul 9, 2022 • edited Loading

PR Info

Adds

More Details

billy1624 left a comment

Choose a reason for hiding this comment

liberwang1013 commented Aug 3, 2022

tyt2y3 commented Aug 7, 2022

billy1624 commented Aug 10, 2022

billy1624 commented Aug 10, 2022 • edited Loading

liberwang1013 commented Aug 20, 2022

liberwang1013 commented Aug 20, 2022

billy1624 commented Aug 24, 2022

billy1624 left a comment

Choose a reason for hiding this comment

tyt2y3 commented Jan 19, 2023 • edited Loading

billy1624 Jan 30, 2023

Choose a reason for hiding this comment

liberwang1013 Jan 30, 2023 • edited Loading

Choose a reason for hiding this comment

billy1624 commented Jan 30, 2023

liberwang1013 commented Jan 30, 2023

tyt2y3 commented Jan 31, 2023 • edited Loading

sutt0n commented Jan 31, 2024

carlocorradini commented May 12, 2024

liberwang1013 commented Jul 9, 2022 •

edited

Loading

billy1624 commented Aug 10, 2022 •

edited

Loading

tyt2y3 commented Jan 19, 2023 •

edited

Loading

liberwang1013 Jan 30, 2023 •

edited

Loading

tyt2y3 commented Jan 31, 2023 •

edited

Loading