sqlmodel-core 0.2.0

Core types and traits for SQLModel Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72

//! Core types and traits for SQLModel Rust.
//!
//! `sqlmodel-core` is the **foundation layer** for the entire ecosystem. It defines the
//! traits and core data types that all other crates build on.
//!
//! # Role In The Architecture
//!
//! - **Contract layer**: `Model` and `Connection` are the primary traits implemented by
//!   user models and database drivers.
//! - **Data model**: `Row`, `Value`, and `SqlType` represent query inputs/outputs and
//!   are shared across query, schema, and driver crates.
//! - **Structured concurrency**: re-exports `Cx` and `Outcome` from asupersync so every
//!   async database operation is cancel-correct and budget-aware.
//!
//! # Who Uses This Crate
//!
//! - `sqlmodel-macros` generates `Model` implementations defined here.
//! - `sqlmodel-query` consumes `Model` metadata and `Value` to build SQL.
//! - `sqlmodel-schema` inspects `Model` metadata to generate DDL.
//! - `sqlmodel-session` depends on `Connection`, `Row`, and `Value` for unit-of-work flows.
//! - Driver crates (`sqlmodel-postgres`, `sqlmodel-mysql`, `sqlmodel-sqlite`) implement
//!   `Connection` and operate on `Row`/`Value`.
//!
//! Most applications should use the `sqlmodel` facade; reach for `sqlmodel-core` directly
//! when writing drivers or advanced integrations.

// Re-export asupersync primitives for structured concurrency
pub use asupersync::{Budget, Cx, Outcome, RegionId, TaskId};

pub mod connection;
pub mod dynamic;
pub mod error;
pub mod field;
pub mod fields_set;
pub mod hybrid;
pub mod identifiers;
pub mod model;
pub mod relationship;
pub mod row;
pub mod tracked;
pub mod types;
pub mod validate;
pub mod value;

pub use connection::{
    Connection, Dialect, IsolationLevel, PreparedStatement, Transaction, TransactionInternal,
    TransactionOps,
};
pub use error::{Error, FieldValidationError, Result, ValidationError, ValidationErrorKind};
pub use field::{
    Column, Field, FieldInfo, InheritanceInfo, InheritanceStrategy, ReferentialAction,
};
pub use fields_set::FieldsSet;
pub use hybrid::Hybrid;
pub use identifiers::{quote_ident, quote_ident_mysql, sanitize_identifier};
pub use model::{
    AttributeChange, AutoIncrement, ExtraFieldsBehavior, Model, ModelConfig, ModelEvents,
    SoftDelete, Timestamps,
};
pub use relationship::{
    Lazy, LazyLoader, LinkTableInfo, PassiveDeletes, Related, RelatedMany, RelationshipInfo,
    RelationshipKind, find_back_relationship, find_relationship, validate_back_populates,
};
pub use row::Row;
pub use tracked::TrackedModel;
pub use types::{SqlEnum, SqlType, TypeInfo};
pub use validate::{
    DumpMode, DumpOptions, DumpResult, ModelDump, ModelValidate, SqlModelDump, SqlModelValidate,
    ValidateInput, ValidateOptions, ValidateResult, apply_serialization_aliases,
    apply_validation_aliases,
};
pub use value::Value;