Attribute Macro entity 

#[entity]

Attribute macro for declaring a SeaORM database entity with auto-registration.

The macro wraps the annotated struct in a SeaORM entity module and submits an EntityRegistration to the inventory collector so modo_db::sync_and_migrate can discover it at startup.

Required argument

• table = "<name>" — SQL table name.

Optional argument

• group = "<name>" — assigns the entity to a named group (default: "default"). Entities in a group can be synced separately via modo_db::sync_and_migrate_group.

Struct-level options (applied as a second #[entity(...)] attribute)

• timestamps — injects created_at and updated_at columns of type DateTime<Utc>; both are set automatically on every insert and update.
• soft_delete — injects a deleted_at: Option<DateTime<Utc>> column. The delete method becomes a soft-delete (sets deleted_at). Extra methods generated on the struct: with_deleted, only_deleted, restore, force_delete, force_delete_by_id, delete_many (bulk soft-delete), force_delete_many (bulk hard-delete). find_all and query are overridden to exclude soft-deleted rows automatically.
• framework — marks the entity as framework-internal (non-user schema).
• index(columns = ["col1", "col2"]) — creates a composite index. Add unique inside to make it a unique index.

Field-level options (applied as #[entity(...)] on individual fields)

• primary_key — marks the field as the primary key.
• auto_increment = true|false — overrides SeaORM’s default auto-increment behaviour.
• auto = "ulid"|"short_id" — generates a ULID or short ID before insert; only valid on primary_key fields.
• unique — adds a unique constraint.
• indexed — creates a single-column index.
• nullable — accepted but has no effect (SeaORM infers nullability from Option<T>).
• column_type = "<type>" — overrides the inferred SeaORM column type string.
• default_value = <literal> — sets a default value (passed to SeaORM).
• default_expr = "<expr>" — sets a default SQL expression string.
• belongs_to = "<Entity>" — declares a BelongsTo relation to the named entity. Pair with on_delete / on_update as needed.
• to_column = "<Column>" — overrides the target column for a belongs_to FK (default: "Id").
• on_delete = "<action>" — FK action on delete. One of: Cascade, SetNull, Restrict, NoAction, SetDefault.
• on_update = "<action>" — FK action on update. Same values as on_delete.
• has_many — declares a HasMany relation (field is excluded from the model). Requires target = "<Entity>".
• has_one — declares a HasOne relation (field is excluded from the model).
• via = "<JoinEntity>" — used with has_many / has_one for many-to-many relations through a join entity.
• target = "<Entity>" — required for has_many; overrides the inferred target entity name for has_one when the field name does not match the entity name.
• renamed_from = "<old_name>" — records a rename hint as a column comment.

Example

#[modo_db::entity(table = "users")]
#[entity(timestamps, soft_delete)]
pub struct User {
    #[entity(primary_key, auto = "ulid")]
    pub id: String,
    #[entity(unique)]
    pub email: String,
    pub name: String,
}