FraiseQL
A Python GraphQL framework for PostgreSQL. Declare types and operations with decorators, point them at PostgreSQL views and functions, and FraiseQL serves a typed GraphQL API over FastAPI — no build step, no code generation.
PostgreSQL returns JSONB. An integrated Rust pipeline (fraiseql_rs) transforms it
into the HTTP response. You write Python; the hot path runs in Rust.
Requires: Python 3.13 or 3.14 · PostgreSQL 13+
import fraiseql
from fraiseql.fastapi import create_fraiseql_app
@fraiseql.type(sql_source="v_user", jsonb_column="data")
class User:
"""A user in the system.
Fields:
id: Unique user identifier
name: User's full name
email: User's email address
"""
id: int
name: str
email: str
@fraiseql.query
async def users(info) -> list[User]:
"""Get all users."""
db = info.context["db"]
return await db.find("v_user")
app = create_fraiseql_app(
database_url="postgresql://localhost/mydb",
types=[User],
queries=[users],
)
Attribute docstrings become GraphQL descriptions. List queries get where,
orderBy, limit and offset wired in automatically.
How it works
Typical ORM stack: PostgreSQL → rows → ORM objects → Python dicts → JSON → HTTP
FraiseQL: PostgreSQL → JSONB → Rust field selection → HTTP
The view composes the whole response shape in one query, so there is no N+1 problem and no Python serialization in the hot path. On the transformation benchmark the JSON step runs 3.6–5.9x faster than the equivalent pure-Python path — 4.1x on a 7 KB nested payload, 4.0x on a 32 KB one.
It also makes the security model structural rather than defensive:
CREATE VIEW v_user AS
SELECT id, jsonb_build_object('id', id, 'email', email) AS data
FROM tb_user;
-- password_hash and api_key are not in the JSONB, so they cannot leak
With an ORM-backed schema, forgetting to exclude a column is a data leak. Here the
view is the contract. Reads go through v_* views and tv_* projection tables;
writes go through fn_* PostgreSQL functions (CQRS).
v1 vs v2 — which repo do you want?
This repository is v1 (fraiseql-python). There is a separate v2 project with a
different architecture. Both are actively maintained.
| v1 — this repo | v2 — fraiseql/fraiseql | |
|---|---|---|
| Status | Stable (1.28.0) | Active (2.16.0; breaking changes ship in minor releases) |
| Engine | Python + Rust pipeline | Compiled Rust engine |
| Schema authoring | Python decorators | 16+ languages |
| Databases | PostgreSQL only | PostgreSQL, MySQL, SQLite, SQL Server |
| Deployment | Runtime (FastAPI, hot reload) | Build-time (fraiseql-cli compile) |
Pick v1 for a Python codebase already invested in PostgreSQL, with fast iteration and no build step. Pick v2 for polyglot teams, multiple databases, or compile-time guarantees.
Is this for you?
Good fit if you run PostgreSQL and are comfortable writing views and functions, want a database-first API, need multi-tenant isolation, care about JSON throughput, or lean on LLMs for code generation — SQL and Python are well-trained, and there is no proprietary DSL in the way.
Look elsewhere if you need a database other than PostgreSQL (that is v2), do not want JSONB in your schema, are building your first GraphQL API, or want an ORM to model your data for you.
See Choosing FraiseQL for a longer comparison.
Quick start
pip install "fraiseql<2" # or: pip install "fraiseql[all]<2"
fraiseql init my-api
cd my-api
fraiseql dev
v1 and v2 share the fraiseql name on PyPI, and the bare name now resolves to v2 —
hence the <2 pin. Your API is live at http://localhost:8000/graphql.
- 5-Minute Quickstart — copy, paste, run
- First Hour Guide — build a complete blog API
- Understanding FraiseQL — architecture in 10 minutes
- Installation — platform notes and troubleshooting
Features
- GraphQL Cascade — mutations report what they changed and which queries to invalidate; clients request as much or as little of it as they want.
- Mutations without boilerplate —
@fraiseql.successauto-injectsstatus,message,updated_fieldsandid; the SQL function holds the business logic. - Specialized scalars — 50+ validated types
(
EmailAddress,Money,IpAddress,LTree,CUSIP,DateRange, …) with type-aware SQL operators. - Advanced filtering — full-text search, JSONB
paths, array operators, regex, ranges, and
nested array filters with
AND/OR/NOT. - Vector search — pgvector integration for semantic search and RAG, with 6 distance operators.
- Trinity identifiers —
pk_*integer keys for fast joins (never exposed),idUUIDs for a stable public API,identifierslugs for URLs. - Security — RLS, rate limiting, CSRF, security
headers, field-level authorization, KMS backends (Vault/AWS/GCP), audit logging, and
SBOM generation via
fraiseql sbom generate. Enforcement maturity varies per feature: security profiles enforce 7 of their 14 settings, and query depth, query complexity, introspection policy and audit level are configured but not enforced by the profile (see the module docstring insrc/fraiseql/security/profiles/definitions.py). Check a given control before relying on it in production. - Everything in PostgreSQL — caching
(
UNLOGGEDtables), error tracking and OpenTelemetry traces live in the same database, so a small deployment needs no Redis, Sentry or APM service. - Automatic Persisted Queries — memory or PostgreSQL-backed storage for multi-instance coordination.
- Resilience testing — a separate, informational workflow runs the 71 failure-injection
tests marked
chaos_real_db(of 145 intests/chaos/) against real PostgreSQL, apart from the per-PR suite (strategy).
Docs and tooling
- Full documentation · Concepts & glossary
- API reference · CLI reference
- Performance guide · Production deployment
- Examples — blog, e-commerce, multi-tenant SaaS, RAG, and more
The fraiseql CLI covers init, dev, check, doctor, generate, sql,
migrate, turbo, sbom and query-stats. Run fraiseql --help or see the
CLI reference. migrate needs the migrate extra:
pip install "fraiseql[migrate]<2".
Contributing
git clone https://github.com/fraiseql/fraiseql-python
cd fraiseql-python
uv sync # runtime + dev deps, builds the Rust extension
uv run pre-commit install
Requires a Rust toolchain for fraiseql_rs. The runtime floor is PostgreSQL 13; the
integration tests want 14+, and CI runs them on 16.
See the Contributing Guide.
About
FraiseQL is created by Lionel Hamayon (@evoludigit). The idea: let PostgreSQL return the JSON, let Rust shape it, and keep Python out of the hot path.
MIT licensed — see LICENSE.
1 maintainer
Metadata
1 maintainer
Release files for fraiseql 1.28.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| fraiseql-1.28.0.tar.gz | 861.4 kB | Without provenance | Details |
Built distributions (wheels)
| File | Reset | |||
|---|---|---|---|---|
| fraiseql-1.28.0-cp314-cp314-win_amd64.whl | CPython 3.14 | CPython 3.14 | Windows x86-64 | Details |
| fraiseql-1.28.0-cp314-cp314-manylinux_2_38_x86_64.whl | CPython 3.14 | CPython 3.14 | Linux glibc 2.38+ x86-64 | Details |
| fraiseql-1.28.0-cp314-cp314-macosx_11_0_arm64.whl | CPython 3.14 | CPython 3.14 | macOS 11.0+ ARM64 | Details |
| fraiseql-1.28.0-cp313-cp313-win_amd64.whl | CPython 3.13 | CPython 3.13 | Windows x86-64 | Details |
| fraiseql-1.28.0-cp313-cp313-manylinux_2_38_x86_64.whl | CPython 3.13 | CPython 3.13 | Linux glibc 2.38+ x86-64 | Details |
| fraiseql-1.28.0-cp313-cp313-macosx_11_0_arm64.whl | CPython 3.13 | CPython 3.13 | macOS 11.0+ ARM64 | Details |
Total release size: 21.9 MB
Release files / fraiseql-1.28.0.tar.gz
| Download URL | fraiseql-1.28.0.tar.gz |
|---|---|
| Size | 861.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
45244099eb522337c796a070139a22b7a203668c7b225bfa2d405378645d1948
|
|
BLAKE2b-256 checksum How to use checksums |
ec253f7178fad68ce66194422eba738d73a502717fa4079b98d32e9ad5740763
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.3
|
Release files / fraiseql-1.28.0-cp314-cp314-win_amd64.whl
| Download URL | fraiseql-1.28.0-cp314-cp314-win_amd64.whl |
|---|---|
| Size | 3.3 MB |
| Tags | CPython 3.14 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
cd3315dba39bf82bd8a9fc02ccd57438604fce6d2d64e1b57a27375a3ffa33b5
|
|
BLAKE2b-256 checksum How to use checksums |
b8b9ed4e8718337e53b58a2a6e7bae39a254b42e573f126bebedd1ded0ca7727
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.3
|
Release files / fraiseql-1.28.0-cp314-cp314-manylinux_2_38_x86_64.whl
| Download URL | fraiseql-1.28.0-cp314-cp314-manylinux_2_38_x86_64.whl |
|---|---|
| Size | 3.7 MB |
| Tags | CPython 3.14 Linux glibc 2.38+ x86-64 |
|
SHA-256 checksum How to use checksums |
69e2bb9e6098f8e5d2195349cfe61c20359a9f48497e2cd0c75a632be64d7680
|
|
BLAKE2b-256 checksum How to use checksums |
3849c4816fee0c22fff6b09b548da82a75940b47d03cc6542984668e57734a7f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.3
|
Release files / fraiseql-1.28.0-cp314-cp314-macosx_11_0_arm64.whl
| Download URL | fraiseql-1.28.0-cp314-cp314-macosx_11_0_arm64.whl |
|---|---|
| Size | 3.4 MB |
| Tags | CPython 3.14 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
97f0860672fd2b6620bad677a0e893127a0c0cf113f0a7186cfe222c8c32fb77
|
|
BLAKE2b-256 checksum How to use checksums |
80c4e3cb71d77b925d6c5b5cf292beb093509c06f5e2f72afa02fea4638b5e53
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.3
|
Release files / fraiseql-1.28.0-cp313-cp313-win_amd64.whl
| Download URL | fraiseql-1.28.0-cp313-cp313-win_amd64.whl |
|---|---|
| Size | 3.3 MB |
| Tags | CPython 3.13 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
d77f60970200f642a0b3befabe759877e9de7e662d31c3c1e20ea9350251b9f8
|
|
BLAKE2b-256 checksum How to use checksums |
0924b036c0ec0ec4708e54c3fc2fd9052d07a6608606b71220b730a1677e9d95
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.3
|
Release files / fraiseql-1.28.0-cp313-cp313-manylinux_2_38_x86_64.whl
| Download URL | fraiseql-1.28.0-cp313-cp313-manylinux_2_38_x86_64.whl |
|---|---|
| Size | 3.7 MB |
| Tags | CPython 3.13 Linux glibc 2.38+ x86-64 |
|
SHA-256 checksum How to use checksums |
f2b47f9c0c9bf3608626a22a4324ca3b9f6e9a15d22c14a55223c81feeb22e0d
|
|
BLAKE2b-256 checksum How to use checksums |
b6c18e47f54afe8eb8553ab31d888b574ebfbbd2963009f012a147d1cacd7d4e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.3
|
Release files / fraiseql-1.28.0-cp313-cp313-macosx_11_0_arm64.whl
| Download URL | fraiseql-1.28.0-cp313-cp313-macosx_11_0_arm64.whl |
|---|---|
| Size | 3.4 MB |
| Tags | CPython 3.13 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
e8751bd5a369dc0cf22723c4e7f56a9bb25730616af84dae01e338e0d9498a5b
|
|
BLAKE2b-256 checksum How to use checksums |
818cfe2862dd74d27bb7c4369b6b1ef5bd324abd4c62bdca786a0a331c78172a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.3
|
Security for fraiseql 1.28.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
