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.1.0 — sync Core foundation with SQLRules pushdown and raise/collect/skip rejection policies.

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.1.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
stream(...) Deferred to 0.3.0

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

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.1.0.tar.gz (176.3 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.1.0-py3-none-any.whl (21.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for rowguard-0.1.0.tar.gz
Algorithm Hash digest
SHA256 9017bea5cbcac5029535696ef70ea6409e54ac5e84d83bbb3b60f50017987006
MD5 820a528dc5359682a2db0610919f0ec9
BLAKE2b-256 89d8fa347da54280f2b9a32b1df1087be66f3fb688d71890e467e261c6ab7a70

See more details on using hashes here.

File details

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

File metadata

  • Download URL: rowguard-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 21.5 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.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f6abdfd3c4c636e8b5361b2fdd5b641368171b14d7839a15109a403c76975cba
MD5 77a6232d73687ac201e379917957946e
BLAKE2b-256 bff0b6a441c5343ee4382411dd84367f6ddcb0c564840124557db6d58a7ac47b

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