Skip to main content

yang_base/database/
mod.rs

1//! 数据库管理模块
2//!
3//! 提供基于 [`crate::table::TableDefinition`] 的声明式 Schema 同步功能。
4//!
5//! # 主要组件
6//!
7//! - [`AnyDatabase`]:运行时数据库后端容器(MySQL / PostgreSQL,需启用 `mysql` 或 `postgres`)
8//! - [`AnyPool`]:与后端共享连接池的可克隆句柄,供受保护查询层使用
9//! - [`AnyTransaction`]:两种后端事务的统一句柄
10//! - [`DatabaseInitializer`]:声明式 Schema 同步器(MySQL / PostgreSQL,按后端分派方言)
11//!
12//! # 后端支持范围
13//!
14//! `mysql` 与 `postgres` feature 均可单独启用并编译 Schema 同步。PostgreSQL 的
15//! DDL 在单事务内执行、使用 `pg_advisory_lock(bigint)` 串行化多实例启动;原生
16//! 枚举、部分/表达式索引与 opaque 存量列按声明式规则演进。Record 解码与受保护
17//! TableQuery / 内置 CRUD 的 PostgreSQL 执行层均已接入。
18//!
19//! # 示例
20//!
21//! ```rust,ignore
22//! use yang_base::database::DatabaseInitializer;
23//! use yang_db::Database;
24//!
25//! let db = Database::connect("mysql://user:pass@localhost/db").await?;
26//! let initializer = DatabaseInitializer::new(db);
27//! initializer.sync_table_definitions(&table_definitions).await?;
28//! ```
29
30#[cfg(test)]
31mod __tests__;
32#[cfg(feature = "postgres")]
33mod adoption;
34#[cfg(any(feature = "mysql", feature = "postgres"))]
35mod backend;
36#[cfg(any(feature = "mysql", feature = "postgres"))]
37mod datasource;
38#[cfg(any(feature = "mysql", feature = "postgres"))]
39mod initializer;
40#[cfg(any(feature = "mysql", feature = "postgres"))]
41mod schema_sync;
42
43#[cfg(feature = "postgres")]
44pub use adoption::{
45    describe_postgres_schema, PgAdoptionColumn, PgAdoptionIndex, PgAdoptionReport, PgAdoptionTable,
46};
47#[cfg(any(feature = "mysql", feature = "postgres"))]
48pub(crate) use backend::AnyTransactionKind;
49#[cfg(any(feature = "mysql", feature = "postgres"))]
50pub use backend::{AnyDatabase, AnyPool, AnyTransaction, PoolHandle};
51#[cfg(any(feature = "mysql", feature = "postgres"))]
52pub use datasource::{Datasource, DatasourceHealth, DatasourcePoolStatus, DatasourceRegistry};
53#[cfg(any(feature = "mysql", feature = "postgres"))]
54pub use initializer::{
55    preflight_table_definitions_grouped, preflight_table_definitions_grouped_outcomes,
56    sync_table_definitions_grouped, sync_table_definitions_grouped_outcomes, DatabaseInitializer,
57};
58#[cfg(any(feature = "mysql", feature = "postgres"))]
59pub use schema_sync::{
60    SchemaBindingChange, SchemaBindingMode, SchemaDataViolation, SchemaPreflightReport,
61    SchemaSyncChange, SchemaSyncChangeKind, SchemaSyncReport,
62};