Struct ColumnAttributes

pub struct ColumnAttributes {
    pub primary_key: Flag,
    pub insertable_primary_key: Flag,
    pub default: Flag,
    pub default_value: Option<NameValue<LitStr>>,
    pub join_column: Option<NameValue<LitStr>>,
    pub many_to_many_table: Option<Ident>,
    pub one_to_many_foreign_key: Option<Path>,
    pub column: Option<LitStr>,
    pub skip: Flag,
    pub experimental_encode_as_json: Flag,
}

Available attributes on a column (struct field)

Fields

primary_key: Flag

insertable_primary_key: Flag

Marks a primary key, but includes it in the Insertable struct.

default: Flag

Specifies that a default exists at the database level.

default_value: Option<NameValue<LitStr>>

Specify a default value on the Rust side.

join_column: Option<NameValue<LitStr>>

Note this column is not expected to exist on the model, but needs to exist in the database. Example: pub struct User { #[ormlitex(join_column = “organization_id”)] pub organization: Join, }

many_to_many_table: Option<Ident>

Example: pub struct User { pub org_id: i32, #[ormlitex(many_to_many_table_name = join_user_role)] pub roles: Join<Vec>, }

one_to_many_foreign_key: Option<Path>

Example: pub struct User { pub id: i32, #[ormlitex(one_to_many_foreign_key = Post::author_id)] pub posts: Join<Vec>, }

pub struct Post { pub id: i32, pub author_id: i32, }

column: Option<LitStr>

The name of the column in the database. Defaults to the field name.

skip: Flag

Skip serializing this field to/from the database. Note the field must implement Default.

experimental_encode_as_json: Flag

Experimental: Encode this field as JSON in the database. Only applies to derive(IntoArguments). For Model structs, wrap the object in Json<..>.

Implementations

impl ColumnAttributes

pub fn is_default(&self) -> bool

Trait Implementations

impl Debug for ColumnAttributes

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

Formats the value using the given formatter.

impl Parse for ColumnAttributes

fn parse(input: ParseStream<'_>) -> Result<Self>