ormer 0.2.3

A minimalist ORM framework that supports SQLite, PostgreSQL, MySQL, and SqlServer
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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108

pub mod abstract_layer;
pub mod error;
pub mod hooks;
pub mod migration;
pub mod model;
pub mod query;
pub mod raw_sql;
mod time;
pub mod utils;

#[cfg(not(any(
    feature = "sqlite",
    feature = "postgresql",
    feature = "mysql",
    feature = "mssql"
)))]
compile_error!(
    "At least one database feature must be enabled: sqlite, postgresql, mysql, or mssql"
);

pub use abstract_layer::DbType;
pub use migration::{
    MIGRATION_TABLE_NAME, Migration, MigrationInfo, MigrationPlan, MigrationRunner, MigrationStep,
    TableMigration,
};

// 数据库相关类型 - 当启用任一数据库 feature 时可用
#[cfg(any(
    feature = "sqlite",
    feature = "postgresql",
    feature = "mysql",
    feature = "mssql"
))]
pub use abstract_layer::{
    ConnectionPool, CreateTableExecutor, Database, DbExecutor, DeleteExecutor,
    DerivedTableCollectFuture, DerivedTableSelectExecutor, DoubleIncludedCollectFuture,
    DoubleIncludedSelectExecutor, DropTableExecutor, InsertGraphExecutor, InsertPartialExecutor,
    IsolationLevel, MappedCollectFuture, MappedSelectExecutor, ModelCollectWithFuture,
    NestedInclude, PooledConnection, PooledDatabaseScope, PooledRawSelectExecutor,
    RawCollectFuture, RawSelectExecutor, RelationNestedLoader, ReplicatedConnectionPool,
    ReplicatedDatabase, ReplicatedDatabaseBuilder, ReplicatedPoolBuilder, ScopedDeleteExecutor,
    ScopedUpdateExecutor, SelectStream, SelectStreamIterator, SingleSqlStatement, SqlExecutor,
    SqlStatement, Transaction, TransactionFuture, TransactionInsertOrIgnoreExecutor,
    TransactionOptions, TransactionRawCollectFuture, TransactionRawSelectExecutor,
    UpdateGraphExecutor,
};
pub use error::{ConstraintKind, DatabaseErrorKind, OrmerError, Result};
pub use hooks::{HookContext, HookOperation};
pub use model::{
    ActiveValue, AfterDelete, AfterInsert, AfterUpdate, BeforeDelete, BeforeInsert, BeforeUpdate,
    DbValue, Embed, EmbedWhere, FieldType, FieldTypeProvider, FromRowValues, FromSingleValue,
    FromValue, GraphWritable, InsertModel, Insertable, Model, ModelEnum, ModelEnumProvider,
    NoInclude, PrimaryKey, Relation, RelationHandle, RelationInfo, RelationKind, RelationPathInfo,
    RelationQuery, RelationSelection, Row, TableRoute, TableRouteValue, ThroughInfo,
    ThroughRelation, Value, ViewModel, WritableModel, generate_create_table_sql,
    generate_create_table_sql_with_name,
};
pub use ormer_derive::{DbValue, Embed, FieldType, InsertModel, Model, ModelEnum, ViewModel, raw};
pub use query::builder::{
    AgeColumn, CursorPage, DerivedSelect, DerivedTableSelect, DynamicColumn, DynamicColumnSet,
    FilterQuery, GroupByColumns, GroupedSelect, InnerJoinedSelect, IntoArrayValue,
    IntoGroupingSets, IntoJsonPath, IsInValue, IsInValues, LeftJoinedSelect, MapToResult,
    MappedSelect, MultiTableSelect, NamedFilterQuery, NumericColumn, PageCursor, RecursiveColumns,
    RelatedSelect, RightJoinedSelect, RowValueCompare, Select, SelectColumnResult, SetOp,
    SubqueryParam, UnionSelect, WhereColumn, WhereExpr, WithoutFilterQuery, from_derived,
};
pub use query::expr::{
    CaseMatchBuilder, IntoRowExpr, IntoSqlExpr, IntoTypedExpr, RawExpr, RawExprSegment, RawSqlExpr,
    SqlExpr, TypedExpr, WindowSpecBuilder, case_match, raw, row, value,
};
pub use query::filter::{FilterExpr, OrderBy, OrderDirection};
pub use query::insert::{
    ConflictColumns, InsertAssignment, InsertConflict, InsertConflictAction, InsertConflictTarget,
    InsertValue, IntoInsertAssignment, IntoInsertConflictTarget, IntoInsertDefaultColumn,
};
pub use query::update::{
    UpdateAssignment, UpdateBinaryOp, UpdateExpr, UpdateField, UpdateFields, UpdateValue,
};
pub use raw_sql::{IntoRawSql, RawSql, sql};

#[doc(hidden)]
#[macro_export]
macro_rules! ormer_error {
    ($fmt:literal $(, $arg:expr)* $(,)?) => {
        $crate::OrmerError::other(format!($fmt $(, $arg)*))
    };
    ($msg:expr $(,)?) => {
        $crate::OrmerError::other($msg)
    };
}

#[macro_export]
macro_rules! expr {
    (match $obj:ident . $field:ident { $($pat:literal => $value:expr,)* _ => $default:expr $(,)? }) => {{
        let mut builder = $crate::query::expr::case_match($obj.$field);
        $(
            builder = builder.when($pat, $value);
        )*
        builder.otherwise($default)
    }};
    (match ($expr:expr) { $($pat:literal => $value:expr,)* _ => $default:expr $(,)? }) => {{
        let mut builder = $crate::query::expr::case_match($expr);
        $(
            builder = builder.when($pat, $value);
        )*
        builder.otherwise($default)
    }};
}