Skip to main content

Validation-first SQLAlchemy queries with Pydantic row validation.

Project description

RowGuard

Validation-first database queries for SQLAlchemy and Pydantic.

RowGuard executes SQLAlchemy queries, validates every returned row against a Pydantic model, and explicitly handles rows that fail validation.

Status

0.2.0 — staged execution planning, plan inspection, precompiled SQLRules, and clearer configuration errors. ORM remains deferred to 0.5.0.

Install

pip install rowguard

Requires Python 3.10+, Pydantic v2, SQLAlchemy 2.x, and SQLRules.

Quickstart

from typing import Annotated

from pydantic import BaseModel, Field
from sqlalchemy import Column, Integer, MetaData, String, Table, create_engine
from sqlalchemy.orm import Session

import rowguard


class UserRead(BaseModel):
    id: int
    name: str
    age: Annotated[int, Field(ge=18)]


metadata = MetaData()
users = Table(
    "users",
    metadata,
    Column("id", Integer, primary_key=True),
    Column("name", String),
    Column("age", Integer),
)

engine = create_engine("sqlite+pysqlite:///:memory:")
metadata.create_all(engine)

with engine.begin() as connection:
    connection.execute(
        users.insert(),
        [
            {"id": 1, "name": "Ada", "age": 37},
            {"id": 2, "name": "Legacy", "age": 12},
        ],
    )

with Session(engine) as session:
    # Disable SQLRules pushdown so invalid rows reach Pydantic and appear in rejected.
    result = rowguard.select(
        session=session,
        table=users,
        model=UserRead,
        on_reject="collect",
        use_sqlrules=False,
    )
    print(result.models)
    print(result.rejected)

With use_sqlrules=True (the default), supported constraints such as age >= 18 are pushed into SQL, so invalid candidate rows may never be returned.

Public API (0.2.0)

Function Purpose
select(...) Build and execute a table query with validation
execute(...) Validate rows from an existing Select
validate_rows(...) Validate mappings without SQL
compile_plan(...) Compile an ExecutionPlan without executing
stream(...) Deferred to 0.3.0

Rejection policies: raise (default), collect, skip.

Optional planning knobs: compiled_rules= (precompiled SQLRules), strict= (Pydantic), field_map= / column_map= (validated at plan time).

Architecture

Pydantic Model
      │
      ▼
SQLRules
      │
      ▼
SQLAlchemy Query
      │
      ▼
Database
      │
      ▼
Row Adapter
      │
      ▼
Pydantic Validation
      │
      ├── Accepted Model
      └── Rejected Row

Documentation

Development

pip install -e ".[dev,async]"
make all          # ruff + mypy + pytest --cov
python examples/basic.py

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rowguard-0.2.0.tar.gz (184.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

rowguard-0.2.0-py3-none-any.whl (26.1 kB view details)

Uploaded Python 3

File details

Details for the file rowguard-0.2.0.tar.gz.

File metadata

  • Download URL: rowguard-0.2.0.tar.gz
  • Upload date:
  • Size: 184.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for rowguard-0.2.0.tar.gz
Algorithm Hash digest
SHA256 f465c8ac031527c9d04c500ecd6a8125b4175dd073c76d2e0570287bf716f96c
MD5 60c3300cfc6bd38c41c82d0f8a4e7b17
BLAKE2b-256 94bf198ec43e0ec99e809635a1f0a85e4eee1f81fa14b4031dbe558928363e68

See more details on using hashes here.

File details

Details for the file rowguard-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: rowguard-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 26.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for rowguard-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5d0fcd5ac1412851d6e0155087493d9cb4396a37631054d204a2ca9f54c80b48
MD5 526cb1167dfc45c3398cc07d7fd17e98
BLAKE2b-256 d6e57a9bb03c371c8c0d973f90f062000140c3e45c6e7bd7f6223bfab66b4cea

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page