Struct datamodel_renderer::datamodel::Relation

pub struct Relation<'a>(/* private fields */);

Defines the relation argument of a model field.

Implementations

impl<'a> Relation<'a>

pub fn new() -> Self

Initialize an empty relation attribute.

pub fn name(&mut self, name: impl Into<Cow<'a, str>>)

Defines the relation name. The attribute will be value-only.

@relation("foo")
//         ^^^ this

pub fn on_delete(&mut self, action: impl Into<Cow<'a, str>>)

Defines the ON DELETE referential action.

@relation(onDelete: DoNothing)
//                  ^^^^^^^^^ this

pub fn on_update(&mut self, action: impl Into<Cow<'a, str>>)

Defines the ON UPDATE referential action.

@relation(onUpdate: DoNothing)
//                  ^^^^^^^^^ this

pub fn map(&mut self, name: impl Into<Cow<'a, str>>)

Defines the foreign key constraint name.

@relation(map: "FK_foo")
//              ^^^^^^ this

pub fn fields(&mut self, fields: impl Iterator<Item = Cow<'a, str>>)

Defines the fields array.

@relation(fields: [foo, bar])
//                ^^^^^^^^^^ this

pub fn references(&mut self, fields: impl Iterator<Item = Cow<'a, str>>)

Defines the references array.

@relation(references: [foo, bar])
//                    ^^^^^^^^^^ this

Trait Implementations

impl<'a> Debug for Relation<'a>

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

Formats the value using the given formatter.

impl<'a> Default for Relation<'a>

fn default() -> Self

Returns the “default value” for a type.

impl<'a> Display for Relation<'a>

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

Formats the value using the given formatter.