For AI agents: the complete documentation index is available at https://a3s-lab.github.io/ORM/v0.3.0/en/llms.txt, the full documentation bundle is available at https://a3s-lab.github.io/ORM/v0.3.0/en/llms-full.txt, and this page is available as Markdown at https://a3s-lab.github.io/ORM/v0.3.0/en/getting-started/installation.md.
  • English
  • v0.3.0
  • Installation and features

    A3S ORM v0.3.0 requires Rust 1.85 or newer. Install the current release from its Git tag.

    Default SQLite runtime

    The default feature is sqlite. This configuration includes the query builder, every dialect compiler, and the Tokio-safe SQLite executor.

    [dependencies]
    a3s-orm = { git = "https://github.com/A3S-Lab/ORM", tag = "v0.3.0" }
    tokio = { version = "1", features = ["macros", "rt-multi-thread"] }

    PostgreSQL runtime

    Disable default features and enable postgres:

    [dependencies]
    a3s-orm = { git = "https://github.com/A3S-Lab/ORM", tag = "v0.3.0", default-features = false, features = ["postgres"] }
    tokio = { version = "1", features = ["macros", "rt-multi-thread"] }

    postgres also enables UUID, JSON, Chrono date and time values, rust_decimal::Decimal, and SqlArray<T>.

    Compiler-only use

    Disable every default feature when your application implements Executor or only needs SQL generation:

    [dependencies]
    a3s-orm = { git = "https://github.com/A3S-Lab/ORM", tag = "v0.3.0", default-features = false }

    This mode still provides PostgresDialect, SqliteDialect, and MysqlDialect without a database client or Tokio dependency.

    Feature list

    FeatureDefaultIncludes
    sqliteYesSqliteExecutor, transactions, savepoints, and migration backend
    postgresNoPostgresExecutor, pool, TLS, transactions, HA controls, and extended values
    chronoNoDate, time, and timestamp values
    decimalNorust_decimal::Decimal
    jsonNoserde_json::Value
    uuidNouuid::Uuid

    Minimum toolchain check

    rustc --version
    cargo check

    PostgreSQL integration tests require A3S_ORM_POSTGRES_URL. Production TLS configuration also needs CA PEM content. See PostgreSQL and high availability.