Struct ModelRoot 

pub struct ModelRoot {
    pub id: ModelId,
    pub name: Name,
    pub fields: Vec<Field>,
    pub primary_key: PrimaryKey,
    pub table_name: Option<String>,
    pub indices: Vec<Index>,
}

A root model backed by its own database table.

Root models have a primary key, may define indices, and are the only model kind that can be the target of relations. They are the main entities users interact with through Toasty’s query API.

Examples

let root = model.as_root_unwrap();
let pk_fields: Vec<_> = root.primary_key_fields().collect();

Fields

id: ModelId

Uniquely identifies this model within the schema.

name: Name

The model’s name.

fields: Vec<Field>

All fields defined on this model.

primary_key: PrimaryKey

The primary key definition. Root models always have a primary key.

table_name: Option<String>

Optional explicit table name. When None, a name is derived from the model name.

indices: Vec<Index>

Secondary indices defined on this model.

Implementations

impl ModelRoot

pub fn find_by_id(&self, input: impl Input) -> Query

Builds a SELECT query that filters by this model’s primary key using the supplied input to resolve argument values.

pub fn primary_key_fields(&self) -> impl ExactSizeIterator<Item = &Field>

Iterate over the fields used for the model’s primary key.

pub fn field_by_name(&self, name: &str) -> Option<&Field>

Looks up a field by its application-level name.

Returns None if no field with that name exists on this model.

Trait Implementations

impl Clone for ModelRoot

fn clone(&self) -> ModelRoot

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ModelRoot

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

Formats the value using the given formatter.

impl From<&ModelRoot> for ModelId

fn from(value: &ModelRoot) -> Self

Converts to this type from the input type.

impl From<&ModelRoot> for Source

fn from(value: &ModelRoot) -> Self

Converts to this type from the input type.

impl<'a, T> IntoExprTarget<'a, T> for &'a ModelRoot

fn into_expr_target(self, _schema: &'a T) -> ExprTarget<'a>

Converts self into an ExprTarget using the provided schema.