For AI agents: the complete documentation index is available at https://a3s-lab.github.io/ORM/v0.2.0/llms.txt, the full documentation bundle is available at https://a3s-lab.github.io/ORM/v0.2.0/llms-full.txt, and this page is available as Markdown at https://a3s-lab.github.io/ORM/v0.2.0/reference/api-map.md.
  • 简体中文
  • v0.2.0
  • API 地图

    本页用于快速定位公共入口。逐项签名与 trait 实现以 docs.rs 和当前 v0.2.0 源码为准。

    Schema 与表达式

    API用途
    orm_table!声明表标记和类型化列
    Table、TableRef表身份与引用
    Column<T, V>带所有权和值类型的列
    Expression布尔与 SQL 表达式 AST
    SqlComparable、SqlNumeric封闭的兼容比较与数值能力标记
    SelectionExt为投影添加别名
    OrderDirectionAsc 或 Desc
    not、exists一元谓词

    查询入口

    API返回
    select_from、select_from_asSelectQuery
    insert_intoInsertQuery
    update_tableUpdateQuery
    delete_fromDeleteQuery
    lock_tableTableLockQuery
    sql_query静态文本 SqlQuery<Output>
    Query带关联 Output 的编译 trait
    InsertRow类型化批量插入行
    ConflictTarget一列或多列冲突目标
    PostgresTableLockMode封闭表锁模式

    函数与窗口

    API用途
    count、count_all、min、max基础聚合
    bound显式类型化绑定表达式
    coalesce、least多参数表达式
    sql_function验证名称的自定义标量函数
    cast验证 SQL 类型名的显式转换
    scalar_subquery单投影子查询表达式
    row_number、rank、dense_rank窗口函数
    WindowExpression、WindowFrame分区、排序与 frame

    执行与解码

    API用途
    CompiledQuerySQL 与绑定参数
    Dialect方言编译能力
    Executor异步执行边界
    Transaction、TransactionManager手动事务契约
    Database<D, E>编译、执行与类型化读取门面
    ExecuteResult、QueryResult<Row>执行结果容器
    Row、FromRow、FromValue解码契约
    Value、SqlArray<T>、IntoSqlValue<T>驱动中立值边界

    驱动

    sqlite feature 导出 SqliteExecutor、SqliteOptions、SqliteJournalMode、SqliteRow、SqliteTransaction、SqliteSavepoint 及其错误。

    postgres feature 导出 PostgresExecutor、pool 与 migration options、TLS options、health 与 metrics 快照、事务 options、row、retry class 及其错误。

    迁移

    Migration、PreparedMigration、AppliedMigration、MigrationBackend、Migrator、MigrationReport、pending_migrations 与迁移错误共同组成只向前迁移契约。