Struct datamodel_renderer::datamodel::Model

pub struct Model<'a> { /* private fields */ }

Defines a model block.

Implementations

impl<'a> Model<'a>

pub fn new(name: impl Into<Cow<'a, str>>) -> Self

Create a new model declaration.

model User {
//    ^^^^ name
}

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

Documentation of the model. If called repeatedly, adds the new docs to the end with a newline. This method is also responsible for avoiding to add the same comment twice (mainly in reintrospection).

/// This is the documentation.
model Foo {
  ....
}

pub fn ignore(&mut self)

Ignore the model.

model Foo {
  @@ignore
  ^^^^^^^^ this
}

pub fn id(&mut self, id: IdDefinition<'a>)

Add a model-level id definition.

model Foo {
  @@id([field1, field2(sort: Desc)])
  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ this
}

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

Add a model-level mapping.

model Foo {
  @@map("1Foo")
  ^^^^^^^^^^^^^ this
}

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

The schema attribute of the model block

model Foo {
  @@schema("public")
  ^^^^^^^^^^^^^^^^^^ this
}

pub fn comment_out(&mut self)

Comments the complete model block out.

// model Foo {
//   id Int @id
// }

pub fn push_field(&mut self, field: Field<'a>)

Push a new field to the end of the model.

model Foo {
  id  Int    @id
  foo String
  ^^^^^^^^^^ this
}

pub fn insert_field_front(&mut self, field: Field<'a>)

Push a new field to the beginning of the model. Extremely inefficient, prefer push_field if you can.

model Foo {
  id  Int    @id
  ^^^^^^^^^^^^^^ this
  foo String
}

pub fn push_index(&mut self, index: IndexDefinition<'a>)

Push a new index to the model.

model Foo {
  @@index([field1, field2])
  ^^^^^^^^^^^^^^^^^^^^^^^^^ this
}

Trait Implementations

impl<'a> Debug for Model<'a>

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

Formats the value using the given formatter.

impl<'a> Display for Model<'a>

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

Formats the value using the given formatter.