For AI agents: the complete documentation index is available at https://a3s-lab.github.io/ORM/en/llms.txt, the full documentation bundle is available at https://a3s-lab.github.io/ORM/en/llms-full.txt, and this page is available as Markdown at https://a3s-lab.github.io/ORM/en/reference/api-map.md.
A3S ORM
  • English
  • v0.3.1

      • API map

      Use this page to locate public entry points. Refer to docs.rs and the selected v0.3.1 source for complete signatures and trait implementations.

      Schema and expressions

      APIPurpose
      orm_table!Declare table markers and typed columns
      Table, TableRefTable identity and references
      Column<T, V>Column with ownership and value type
      ExpressionBoolean and SQL expression AST
      SqlComparable, SqlNumericClosed compatibility and numeric capability markers
      SelectionExtAdd an alias to a projection
      OrderDirectionAsc or Desc
      not, existsUnary predicates

      Query entry points

      APIReturns
      select_from, select_from_asSelectQuery
      insert_intoInsertQuery
      update_tableUpdateQuery
      delete_fromDeleteQuery
      lock_tableTableLockQuery
      sql_queryStatic-text SqlQuery<Output>
      QueryCompilation trait with associated Output
      InsertRowTyped batch-insert row
      ConflictTargetOne-column or multi-column conflict target
      PostgresTableLockModeClosed table-lock mode

      The v0.3.1 UpdateQuery also exposes with, set_expression, and from for typed UPDATE CTEs and UPDATE FROM.

      Functions and windows

      APIPurpose
      count, count_all, min, maxBasic aggregates
      boundExplicit typed bound expression
      coalesce, leastMulti-argument expressions
      sql_functionCustom scalar function with validated name
      castExplicit conversion with validated SQL type name
      scalar_subquerySingle-projection subquery expression
      row_number, rank, dense_rankWindow functions
      WindowExpression, WindowFramePartitioning, ordering, and frames

      Execution and decoding

      APIPurpose
      CompiledQuerySQL plus bound parameters
      DialectDialect compilation capabilities
      ExecutorAsync execution boundary
      Transaction, TransactionManagerManual transaction contract
      Database<D, E>Compile, execute, and typed-fetch facade
      ExecuteResult, QueryResult<Row>Result containers
      Row, FromRow, FromValueDecoding contract
      Value, SqlArray<T>, IntoSqlValue<T>Driver-neutral value boundary

      Drivers

      The sqlite feature exports SqliteExecutor, SqliteOptions, SqliteJournalMode, SqliteRow, SqliteTransaction, SqliteSavepoint, and their errors.

      The postgres feature exports PostgresExecutor, pool and migration options, TLS options, health and metric snapshots, transaction options, row, retry class, and their errors.

      Migrations

      Migration, PreparedMigration, AppliedMigration, MigrationBackend, Migrator, MigrationReport, pending_migrations, and migration errors form the forward-only migration contract.

      MigrationLedger, Migrator::verify_required, and MissingAppliedMigration add non-mutating schema admission for serving processes without DDL authority.