# Ferro ORM

> A high-performance, Rust-backed, Pydantic-driven async ORM for Python.

Ferro is an async Python ORM: Pydantic models, a Rust core, SQLite and Postgres.

## Get started

- [Ferro ORM](<https://ferro-orm.x54.sh/index.md>)
- [Why Ferro](<https://ferro-orm.x54.sh/why-ferro/index.md>)
- [Installation](<https://ferro-orm.x54.sh/getting-started/installation/index.md>)
- [Quickstart](<https://ferro-orm.x54.sh/getting-started/quickstart/index.md>)

## Guide

- [Aggregations and grouped queries](<https://ferro-orm.x54.sh/guide/aggregations/index.md>)
- [Connections](<https://ferro-orm.x54.sh/guide/connections/index.md>)
- [Models and fields](<https://ferro-orm.x54.sh/guide/models-and-fields/index.md>)
- [Mutations](<https://ferro-orm.x54.sh/guide/mutations/index.md>)
- [Queries](<https://ferro-orm.x54.sh/guide/queries/index.md>)
- [Raw SQL](<https://ferro-orm.x54.sh/guide/raw-sql/index.md>)
- [Relationships](<https://ferro-orm.x54.sh/guide/relationships/index.md>)
- [Scope rows by tenant with Postgres row-level security](<https://ferro-orm.x54.sh/guide/row-level-security/index.md>)
- [Adopting migrations on an existing database](<https://ferro-orm.x54.sh/guide/schema/adopting-migrations/index.md>)
- [Alembic bridge](<https://ferro-orm.x54.sh/guide/schema/alembic/index.md>)
- [Auto-migrate](<https://ferro-orm.x54.sh/guide/schema/auto-migrate/index.md>)
- [Data steps and backfills](<https://ferro-orm.x54.sh/guide/schema/data-steps/index.md>)
- [Deploying migrations](<https://ferro-orm.x54.sh/guide/schema/deploying/index.md>)
- [Migrations](<https://ferro-orm.x54.sh/guide/schema/migrations/index.md>)
- [Overview of schema management](<https://ferro-orm.x54.sh/guide/schema/overview/index.md>)
- [Renaming and retiring columns and labels](<https://ferro-orm.x54.sh/guide/schema/renames-and-retirements/index.md>)
- [Squashing a feature branch's migrations](<https://ferro-orm.x54.sh/guide/schema/squash/index.md>)
- [Testing migrations](<https://ferro-orm.x54.sh/guide/schema/testing/index.md>)
- [Transactions](<https://ferro-orm.x54.sh/guide/transactions/index.md>)

## How-to

- [Migrate from SQLAlchemy](<https://ferro-orm.x54.sh/howto/migrate-from-sqlalchemy/index.md>)
- [How to use several databases in one app](<https://ferro-orm.x54.sh/howto/multiple-databases/index.md>)
- [How to paginate query results](<https://ferro-orm.x54.sh/howto/pagination/index.md>)
- [How to soft-delete rows](<https://ferro-orm.x54.sh/howto/soft-deletes/index.md>)
- [How to test a Ferro app with pytest](<https://ferro-orm.x54.sh/howto/testing/index.md>)
- [How to record created and updated times](<https://ferro-orm.x54.sh/howto/timestamps/index.md>)

## Concepts

- [Architecture](<https://ferro-orm.x54.sh/concepts/architecture/index.md>)
- [Database backends](<https://ferro-orm.x54.sh/concepts/backends/index.md>)
- [Identity map](<https://ferro-orm.x54.sh/concepts/identity-map/index.md>)
- [Performance](<https://ferro-orm.x54.sh/concepts/performance/index.md>)
- [Typed query predicates](<https://ferro-orm.x54.sh/concepts/query-typing/index.md>)
- [Row-level security and session settings](<https://ferro-orm.x54.sh/concepts/row-level-security/index.md>)
- [Type safety](<https://ferro-orm.x54.sh/concepts/type-safety/index.md>)

## Reference

- [CLI](<https://ferro-orm.x54.sh/reference/cli/index.md>)
- [Configuration](<https://ferro-orm.x54.sh/reference/configuration/index.md>)
- [Migrations reference](<https://ferro-orm.x54.sh/reference/migrations/index.md>)
- [Row-level security](<https://ferro-orm.x54.sh/reference/row-level-security/index.md>)
- [connect, Session and the registry](<https://ferro-orm.x54.sh/api/connection/index.md>)
- [FerroError and its subclasses](<https://ferro-orm.x54.sh/api/exceptions/index.md>)
- [Field, FerroField and DbType](<https://ferro-orm.x54.sh/api/fields/index.md>)
- [ferro.migrations](<https://ferro-orm.x54.sh/api/migrations/index.md>)
- [Model](<https://ferro-orm.x54.sh/api/model/index.md>)
- [Query](<https://ferro-orm.x54.sh/api/queries/index.md>)
- [execute, fetch\_all and fetch\_one](<https://ferro-orm.x54.sh/api/raw-sql/index.md>)
- [ForeignKey, BackRef, ManyToMany and Relation](<https://ferro-orm.x54.sh/api/relationships/index.md>)
- [transaction and Transaction](<https://ferro-orm.x54.sh/api/transactions/index.md>)

## Project

- [FAQ](<https://ferro-orm.x54.sh/faq/index.md>)
- [Roadmap](<https://ferro-orm.x54.sh/roadmap/index.md>)
- [Upgrading between versions](<https://ferro-orm.x54.sh/upgrading/index.md>)
- [Changelog](<https://ferro-orm.x54.sh/changelog/index.md>)
- [Contributing](<https://ferro-orm.x54.sh/contributing/index.md>)