Struct SchemaObject 

pub struct SchemaObject {

    pub id: Option<String>,
    pub name: String,
    pub physical_name: Option<String>,
    pub physical_type: Option<String>,
    pub business_name: Option<String>,
    pub description: Option<String>,
    pub data_granularity_description: Option<String>,
    pub properties: Vec<Property>,
    pub relationships: Vec<SchemaRelationship>,
    pub quality: Vec<QualityRule>,
    pub authoritative_definitions: Vec<AuthoritativeDefinition>,
    pub tags: Vec<String>,
    pub custom_properties: Vec<CustomProperty>,
}

SchemaObject - one table/view/topic in a contract (ODCS v3.1.0)

Schema objects represent individual data structures within a contract. Each schema object contains properties (columns) and can have its own metadata like quality rules, relationships, and authoritative definitions.

Example

use data_modelling_core::models::odcs::{SchemaObject, Property};

let users_table = SchemaObject::new("users")
    .with_physical_name("tbl_users")
    .with_physical_type("table")
    .with_business_name("User Accounts")
    .with_description("Contains registered user information")
    .with_properties(vec![
        Property::new("id", "integer").with_primary_key(true),
        Property::new("email", "string").with_required(true),
        Property::new("name", "string"),
    ]);

Fields

id: Option<String>

Stable technical identifier

name: String

Schema object name (table/view name)

physical_name: Option<String>

Physical name in the data source

physical_type: Option<String>

Physical type (“table”, “view”, “topic”, “file”, “object”, “stream”)

business_name: Option<String>

Business name for the schema object

description: Option<String>

Schema object description/documentation

data_granularity_description: Option<String>

Description of the data granularity (e.g., “One row per customer per day”)

properties: Vec<Property>

List of properties/columns in this schema object

relationships: Vec<SchemaRelationship>

Schema-level relationships to other schema objects

quality: Vec<QualityRule>

Quality rules and checks at schema level

authoritative_definitions: Vec<AuthoritativeDefinition>

Authoritative definitions for this schema object

tags: Vec<String>

Schema-level tags

custom_properties: Vec<CustomProperty>

Custom properties for format-specific metadata

Implementations

impl SchemaObject

pub fn new(name: impl Into<String>) -> Self

Create a new schema object with the given name

pub fn with_physical_name(self, physical_name: impl Into<String>) -> Self

Set the physical name

pub fn with_physical_type(self, physical_type: impl Into<String>) -> Self

Set the physical type

pub fn with_business_name(self, business_name: impl Into<String>) -> Self

Set the business name

pub fn with_description(self, description: impl Into<String>) -> Self

Set the description

pub fn with_data_granularity_description( self, description: impl Into<String>, ) -> Self

Set the data granularity description

pub fn with_properties(self, properties: Vec<Property>) -> Self

Set the properties (columns)

pub fn with_property(self, property: Property) -> Self

Add a property

pub fn with_relationships(self, relationships: Vec<SchemaRelationship>) -> Self

Set the relationships

pub fn with_relationship(self, relationship: SchemaRelationship) -> Self

Add a relationship

pub fn with_quality(self, quality: Vec<QualityRule>) -> Self

Set the quality rules

pub fn with_quality_rule(self, rule: QualityRule) -> Self

Add a quality rule

pub fn with_authoritative_definitions( self, definitions: Vec<AuthoritativeDefinition>, ) -> Self

Set the authoritative definitions

pub fn with_authoritative_definition( self, definition: AuthoritativeDefinition, ) -> Self

Add an authoritative definition

pub fn with_tags(self, tags: Vec<String>) -> Self

Set the tags

pub fn with_tag(self, tag: impl Into<String>) -> Self

Add a tag

pub fn with_custom_properties( self, custom_properties: Vec<CustomProperty>, ) -> Self

Set the custom properties

pub fn with_custom_property(self, custom_property: CustomProperty) -> Self

Add a custom property

pub fn with_id(self, id: impl Into<String>) -> Self

Set the ID

pub fn primary_key_properties(&self) -> Vec<&Property>

Get the primary key properties

pub fn required_properties(&self) -> Vec<&Property>

Get the required properties

pub fn get_property(&self, name: &str) -> Option<&Property>

Get a property by name

pub fn get_property_mut(&mut self, name: &str) -> Option<&mut Property>

Get a mutable property by name

pub fn property_count(&self) -> usize

Count of properties

pub fn has_nested_properties(&self) -> bool

Check if this schema has any nested/complex properties

Trait Implementations

impl Clone for SchemaObject

fn clone(&self) -> SchemaObject

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SchemaObject

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

Formats the value using the given formatter.

impl Default for SchemaObject

fn default() -> SchemaObject

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SchemaObject

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&SchemaObject> for Table

fn from(schema: &SchemaObject) -> Self

Convert a SchemaObject to a Table

This flattens nested properties to dot-notation column names.

impl From<&Table> for SchemaObject

fn from(table: &Table) -> Self

Convert a Table to a SchemaObject

This reconstructs nested property structure from dot-notation column names.

impl PartialEq for SchemaObject

fn eq(&self, other: &SchemaObject) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for SchemaObject

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SchemaObject