Expand description
Data Modelling SDK - Shared library for model operations across platforms
This crate re-exports everything from data-modelling-core for backward compatibility.
Provides unified interfaces for:
- File/folder operations (via storage backends)
- Model loading/saving
- Import/export functionality
- Validation logic
- Authentication types (shared across web, desktop, mobile)
- Workspace management types
Modules§
- auth
- Authentication types shared across all platforms
- convert
- Universal format converter module
- export
- Export functionality
- import
- Import functionality
- model
- Model loading and saving functionality
- models
- Models module for the SDK
- storage
- Storage backend abstraction
- validation
- Validation functionality
- workspace
- Workspace types shared across all platforms
Structs§
- ApiModel
Loader - API-based model loader
- ApiStorage
Backend - API storage backend that communicates with HTTP API
- Auth
State - Current authentication state
- Avro
Exporter - Exporter for AVRO schema format.
- Avro
Importer - Parser for AVRO schema format.
- Column
- Column model representing a field in a table
- Contact
Details - Contact details for Data Flow node/relationship owners/responsible parties
- Create
Workspace Request - Request to create a workspace
- Create
Workspace Response - Response after creating a workspace
- Data
Model - Data model representing a complete data model with tables and relationships
- Export
Result - Result of an export operation.
- Foreign
Key - Foreign key reference to another table’s column
- GitHub
Email - GitHub email information
- Import
Result - Result of an import operation.
- InitiateO
Auth Request - OAuth initiation request
- InitiateO
Auth Response - OAuth initiation response
- JSON
Schema Exporter - Exporter for JSON Schema format.
- JSON
Schema Importer - Parser for JSON Schema format.
- List
Profiles Response - List profiles response
- Load
Profile Request - Load profile request
- Model
Loader - Model loader that uses a storage backend
- Model
Saver - Model saver that uses a storage backend
- ODCS
Exporter - Exporter for ODCS (Open Data Contract Standard) v3.1.0 YAML format.
- ODCS
Importer - ODCS parser service for parsing Open Data Contract Standard YAML files. Handles ODCS v3.1.0 (primary format) and legacy ODCL formats (converted to ODCS).
- Profile
Info - Profile information (user profile with domains)
- Protobuf
Exporter - Exporter for Protobuf format.
- Protobuf
Importer - Parser for Protobuf format.
- Relationship
- Relationship model representing a connection between two tables
- Relationship
Validation Result - Result of relationship validation.
- SQLExporter
- Exporter for SQL CREATE TABLE format.
- SQLImporter
- SQL Importer - parses CREATE TABLE statements
- Select
Email Request - Email selection request
- SlaProperty
- SLA (Service Level Agreement) property following ODCS-inspired structure
- Table
- Table model representing a database table or data contract
- Table
Validation Result - Result of table validation.
- Workspace
Info - Workspace information
Enums§
- Auth
Mode - Authentication mode
- Cardinality
- Legacy cardinality enum (for backward compatibility) Consider using EndpointCardinality for more precise crow’s feet notation
- Conversion
Error - Error during format conversion
- Data
Vault Classification - Database
Type - Endpoint
Cardinality - Crow’s feet notation endpoint cardinality
- Export
Error - Error during export
- Flow
Direction - Flow direction for data flow relationships
- Import
Error - Error during import
- Infrastructure
Type - Infrastructure type for Data Flow nodes and relationships
- Medallion
Layer - Modeling
Level - Relationship
Type - Relationship
Validation Error - Error during relationship validation
- SCDPattern
- Storage
Error - Error type for storage operations
- Table
Validation Error - Error during table validation
Traits§
- Storage
Backend - Trait for storage backends
Functions§
- convert_
to_ odcs - Convert any import format to ODCS v3.1.0 YAML format.