Welcome to sqlatypemodel’s documentation!

Typed JSON fields for SQLAlchemy with automatic mutation tracking.

sqlatypemodel solves the “immutable JSON” problem in SQLAlchemy. It allows you to use strictly typed Python objects (Pydantic, Dataclasses, Attrs) as database columns while ensuring that every change—no matter how deep—is automatically saved.

Quick Links

• PyPI: https://pypi.org/project/sqlatypemodel/

• GitHub: https://github.com/GrehBan/sqlatypemodel

• CI/CD: GitHub Actions

CI/CD Status

• Tests

• Linting

• Security

• Documentation

Documentation

sqlatypemodel Documentation:

• sqlatypemodel
• Typed JSON fields for SQLAlchemy with automatic mutation tracking
  • Key Features
  • The Problem
  • The Solution
  • Resources
  • License
• sqlatypemodel
  • sqlatypemodel package

Getting Started:

• Installation
  • With Development Dependencies
  • Requirements
  • Optional Dependencies
  • Supported Databases
  • Integration with CI/CD
• Usage Guide
  • Table of Contents
  • Getting Started
  • Pydantic Integration
  • Python Dataclasses
  • Attrs Integration
  • Loading Strategies: Eager vs Lazy
  • Async Support
  • Custom Serialization
  • Error Handling
  • Advanced Patterns
  • Development & CI/CD
• Configuration
  • Nesting Depth Limit
  • Change Suppression
  • SQLAlchemy Engine
  • Environment Variables
  • Testing Configuration

Reference:

• API Reference
  • sqlatypemodel package
• Architecture & Internals
  • State-Based Tracking
  • Lazy Loading & JIT Wrapping
  • Serialization (orjson)
  • Recursion & Safety
  • Circular References
  • Code Quality & Testing
• Best Practices
  • Performance
  • Safety
  • Serialization
  • Testing
  • Code Quality
  • Deployment
• Caveats & Restrictions
  • 64-bit Integer Limit
  • Mixed Types in Lazy Collections
  • Thread Safety
  • SQLAlchemy Dialects
  • Pydantic V2 “Extra” Fields
  • Pre-commit Hook Requirements
  • Python Version Support
  • MyPy Strict Mode
• Examples
  • Quick Start
  • Available Examples
  • Safety & Testing
  • Performance Benchmarks

Development:

• Contributing
  • Development Setup
  • Code Quality
  • Testing
  • CI/CD Workflows
  • Pull Request Process
  • Release Process
  • Code Standards
  • Getting Help
• Changelog
  • [0.8.3] - 2026-01-18
  • [0.8.2] - 2026-01-18 (Optimization & Concurrency Release)
  • [0.8.1p2] - 2026-01-17 (Performance Analysis & Documentation Correction)
  • [0.8.0] - 2026-01-17
  • [0.7.0] - 2025-12-22
  • [0.6.0] - 2025-12-19
  • [0.5.1] - 2025-12-18
  • [0.5.0] - 2025-12-18

Indices and tables

• Index

• Module Index

• Search Page