{"library":"sqlalchemy-json","title":"SQLAlchemy JSON","type":"library","description":"SQLAlchemy-JSON provides mutation-tracked JSON types to SQLAlchemy. It includes `MutableJson` for tracking top-level changes in JSON objects and `NestedMutableJson` for deep tracking within nested objects or lists. The library is actively maintained with recent releases focusing on Python 3 compatibility and enhanced functionality.","language":"python","status":"active","last_verified":"Fri May 22","install":{"commands":["pip install sqlalchemy-json"],"cli":null},"imports":["from sqlalchemy_json import MutableJson","from sqlalchemy_json import NestedMutableJson","from sqlalchemy_json import MutableJson","from sqlalchemy_json import NestedMutableJson"],"auth":{"required":false,"env_vars":[]},"links":{"homepage":"https://sqlalchemy-json.readthedocs.io","github":"https://github.com/edelooff/sqlalchemy-json","docs":null,"changelog":null,"pypi":"https://pypi.org/project/sqlalchemy-json/","npm":null,"openapi_spec":null,"status_page":null,"smithery":null},"quickstart":{"code":"import os\nfrom datetime import datetime\nfrom sqlalchemy import create_engine, Column, Text, ForeignKey, Integer, DateTime\nfrom sqlalchemy.orm import declarative_base, sessionmaker, Mapped, mapped_column\nfrom sqlalchemy_json import MutableJson, NestedMutableJson\n\n# Setup database (in-memory SQLite for example)\nDATABASE_URL = os.environ.get('DATABASE_URL', 'sqlite:///:memory:')\nengine = create_engine(DATABASE_URL, echo=True)\nSession = sessionmaker(bind=engine)\nBase = declarative_base()\n\n# Define models\nclass Author(Base):\n    __tablename__ = \"authors\"\n    id: Mapped[int] = mapped_column(Integer, primary_key=True)\n    name: Mapped[str] = mapped_column(Text)\n    # MutableJson for top-level changes\n    handles: Mapped[dict] = mapped_column(MutableJson)\n\nclass Article(Base):\n    __tablename__ = \"articles\"\n    id: Mapped[int] = mapped_column(Integer, primary_key=True)\n    author_id: Mapped[int] = mapped_column(ForeignKey('authors.id'))\n    content: Mapped[str] = mapped_column(Text)\n    # NestedMutableJson for deep changes\n    references: Mapped[dict] = mapped_column(NestedMutableJson)\n\n# Create tables\nBase.metadata.create_all(engine)\n\nsession = Session()\n\n# Example for MutableJson\nauthor = Author(name='John Doe', handles={'twitter': '@JohnDoe', 'facebook': 'JohnDoe'})\nsession.add(author)\nsession.commit()\n\n# Retrieve and modify top-level JSON\nretrieved_author = session.query(Author).first()\nprint(f\"Original handles: {retrieved_author.handles}\")\nretrieved_author.handles['twitter'] = '@JDoe'\nsession.commit() # Change is detected\nprint(f\"Updated handles (MutableJson): {retrieved_author.handles}\")\n\n# Example for NestedMutableJson\narticle = Article(\n    author_id=retrieved_author.id,\n    content='Some article content',\n    references={'github.com': {'repo1': 4, 'repo2': 7}, 'example.com': {'link1': 2}}\n)\nsession.add(article)\nsession.commit()\n\n# Retrieve and modify nested JSON\nretrieved_article = session.query(Article).first()\nprint(f\"Original references: {retrieved_article.references}\")\nretrieved_article.references['github.com']['repo1'] += 10 # Nested change\nsession.commit() # Change is detected\nprint(f\"Updated references (NestedMutableJson): {retrieved_article.references}\")\n\nsession.close()\n","lang":"python","description":"This quickstart demonstrates defining SQLAlchemy models with `MutableJson` for top-level mutable JSON fields and `NestedMutableJson` for fields requiring deep mutation tracking. It shows how changes to the JSON data are automatically detected and persisted to the database upon session commit.","tag":null,"tag_description":null,"last_tested":null,"results":[]},"compatibility":{"tag":null,"tag_description":null,"last_tested":"2026-05-22","installed_version":"0.7.0","pypi_latest":"0.7.0","is_stale":false,"summary":{"python_range":"3.10–3.9","success_rate":100,"avg_install_s":3.2,"avg_import_s":0.86,"wheel_type":"wheel"},"results":[{"runtime":"python:3.10-alpine","python_version":"3.10","os_libc":"alpine (musl)","variant":"sqlalchemy-json","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":0.73,"mem_mb":20.8,"disk_size":"42.5M"},{"runtime":"python:3.10-slim","python_version":"3.10","os_libc":"slim (glibc)","variant":"sqlalchemy-json","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":3.3,"import_time_s":0.53,"mem_mb":20.8,"disk_size":"41M"},{"runtime":"python:3.11-alpine","python_version":"3.11","os_libc":"alpine (musl)","variant":"sqlalchemy-json","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":1.02,"mem_mb":23.3,"disk_size":"47.6M"},{"runtime":"python:3.11-slim","python_version":"3.11","os_libc":"slim (glibc)","variant":"sqlalchemy-json","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":3,"import_time_s":0.92,"mem_mb":23.3,"disk_size":"46M"},{"runtime":"python:3.12-alpine","python_version":"3.12","os_libc":"alpine (musl)","variant":"sqlalchemy-json","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":1.05,"mem_mb":22.5,"disk_size":"38.9M"},{"runtime":"python:3.12-slim","python_version":"3.12","os_libc":"slim (glibc)","variant":"sqlalchemy-json","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":2.8,"import_time_s":1.06,"mem_mb":22.5,"disk_size":"37M"},{"runtime":"python:3.13-alpine","python_version":"3.13","os_libc":"alpine (musl)","variant":"sqlalchemy-json","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":1.05,"mem_mb":22.7,"disk_size":"38.4M"},{"runtime":"python:3.13-slim","python_version":"3.13","os_libc":"slim (glibc)","variant":"sqlalchemy-json","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":2.9,"import_time_s":1,"mem_mb":22.7,"disk_size":"37M"},{"runtime":"python:3.9-alpine","python_version":"3.9","os_libc":"alpine (musl)","variant":"sqlalchemy-json","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":0.64,"mem_mb":19.9,"disk_size":"41.1M"},{"runtime":"python:3.9-slim","python_version":"3.9","os_libc":"slim (glibc)","variant":"sqlalchemy-json","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":3.9,"import_time_s":0.6,"mem_mb":19.9,"disk_size":"40M"}]}}