Struct DataModel 

pub struct DataModel {
    pub id: Uuid,
    pub name: String,
    pub description: Option<String>,
    pub git_directory_path: String,
    pub tables: Vec<Table>,
    pub relationships: Vec<Relationship>,
    pub control_file_path: String,
    pub diagram_file_path: Option<String>,
    pub is_subfolder: bool,
    pub parent_git_directory: Option<String>,
    pub created_at: DateTime<Utc>,
    pub updated_at: DateTime<Utc>,
}

Data model representing a complete data model with tables and relationships

A DataModel is a container for a collection of tables and their relationships. It represents a workspace or domain within a larger data modeling system.

Example

use data_modelling_sdk::models::DataModel;

let model = DataModel::new(
    "MyModel".to_string(),
    "/path/to/git".to_string(),
    "control.yaml".to_string(),
);

Fields

id: Uuid

Unique identifier for the model (UUIDv5 based on name and path)

name: String

Model name

description: Option<String>

Optional description of the model

git_directory_path: String

Path to the Git repository directory

tables: Vec<Table>

Tables in this model

relationships: Vec<Relationship>

Relationships between tables

control_file_path: String

Path to the control file (relationships.yaml)

diagram_file_path: Option<String>

Path to diagram file if applicable

is_subfolder: bool

Whether this model is in a subfolder

parent_git_directory: Option<String>

Parent Git directory if this is a subfolder

created_at: DateTime<Utc>

Creation timestamp

updated_at: DateTime<Utc>

Last update timestamp

Implementations

impl DataModel

pub fn new( name: String, git_directory_path: String, control_file_path: String, ) -> Self

Create a new data model with the given name and paths

Arguments

• name - The model name
• git_directory_path - Path to the Git repository directory
• control_file_path - Path to the control file (typically “relationships.yaml”)

Returns

A new DataModel instance with a UUIDv5 ID (deterministic based on name and path) and current timestamps.

Example

use data_modelling_sdk::models::DataModel;

let model = DataModel::new(
    "MyModel".to_string(),
    "/workspace/models".to_string(),
    "relationships.yaml".to_string(),
);

pub fn get_table_by_id(&self, table_id: Uuid) -> Option<&Table>

Get a table by its ID

Arguments

• table_id - The UUID of the table to find

Returns

A reference to the table if found, None otherwise.

pub fn get_table_by_id_mut(&mut self, table_id: Uuid) -> Option<&mut Table>

Get a mutable reference to a table by its ID

Arguments

• table_id - The UUID of the table to find

Returns

A mutable reference to the table if found, None otherwise.

pub fn get_table_by_name(&self, name: &str) -> Option<&Table>

Get a table by its name

Arguments

• name - The name of the table to find

Returns

A reference to the first table with the given name if found, None otherwise.

Note

If multiple tables have the same name (different database_type/catalog/schema), use get_table_by_unique_key instead.

pub fn get_table_by_unique_key( &self, database_type: Option<&str>, name: &str, catalog_name: Option<&str>, schema_name: Option<&str>, ) -> Option<&Table>

Get a table by its unique key (database_type, name, catalog, schema)

Arguments

• database_type - Optional database type
• name - Table name
• catalog_name - Optional catalog name
• schema_name - Optional schema name

Returns

A reference to the table if found, None otherwise.

Example

// Find table in specific schema
let table = model.get_table_by_unique_key(
    Some("PostgreSQL"),
    "users",
    Some("mydb"),
    Some("public"),
);

pub fn get_relationships_for_table(&self, table_id: Uuid) -> Vec<&Relationship>

Get all relationships involving a specific table

Arguments

• table_id - The UUID of the table

Returns

A vector of references to relationships where the table is either the source or target.

Example

// Get all relationships for a table
let relationships = model.get_relationships_for_table(table_id);

Trait Implementations

impl Clone for DataModel

fn clone(&self) -> DataModel

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DataModel

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DataModel

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for DataModel

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.