Преобразуйте JSON в схему SQLAlchemy!

Введите JSON и преобразуйте его в схему SQLAlchemy! Поддержка: SQLAlchemy 2.0 ORM, Mapped, mapped_column, Flask, FastAPI.
JSON
Результат
 

Преобразуйте JSON в схему SQLAlchemy!

Преобразует JSON в готовую к запуску декларативную модель SQLAlchemy 2.0: класс Base(DeclarativeBase), аннотации типов Mapped[...] с mapped_column(), флаги nullable, __tablename__ и первичный ключ Integer.

Хорошая отправная точка, когда бэкенду на FastAPI или Flask нужно сохранять JSON запросов или данные, загруженные из другой системы, в таблицу, для которой ещё нет модели.

Как пользоваться

  1. Вставьте JSON-объект, представляющий одну строку таблицы. Если в некоторых строках значения пусты, вставьте несколько строк массивом, чтобы nullable=True определился.
  2. Введите имя класса в Имя модели (по умолчанию MyModel); __tablename__ — это имя в верхнем snake case.
  3. Сохраните вывод как models.py. Если в проекте уже есть Base, удалите сгенерированный и импортируйте свой, чтобы все модели разделяли одну metadata.

Пример

Вход (JSON)
{
  "isbn": "978-0-13-468599-1",
  "title": "The Pragmatic Programmer",
  "pages": 352,
  "rating": 4.7,
  "available": true,
  "published_at": "2019-09-13"
}
Результат (SQLAlchemy 2.0)
from datetime import date

from sqlalchemy import Boolean, Date, Float, Integer, String
from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column


class Base(DeclarativeBase):
    pass


class Book(Base):
    __tablename__ = "BOOK"

    id: Mapped[int] = mapped_column(Integer, primary_key=True)
    isbn: Mapped[str] = mapped_column(String(255), nullable=False)
    title: Mapped[str] = mapped_column(String(255), nullable=False)
    pages: Mapped[int] = mapped_column(Integer, nullable=False)
    rating: Mapped[float] = mapped_column(Float, nullable=False)
    available: Mapped[bool] = mapped_column(Boolean, nullable=False)
    published_at: Mapped[date] = mapped_column(Date, nullable=False)

isbn с дефисами остаётся String(255), pages становится Integer, rating — Float, а published_at, дата без времени, — Date с аннотацией date. Все значения присутствуют, поэтому все колонки nullable=False.

Возможности

  • Определяет class Base(DeclarativeBase): pass и импортирует только реально используемые типы SQLAlchemy и имена из datetime.
  • Сопоставление типов: целые → Integer/int (BigInteger для больших значений), дробные → Float, булевы → Boolean, YYYY-MM-DD → Date/date, дата-время → DateTime/datetime, объекты и массивы → JSON с dict/list.
  • Строки — String(255) или Text, если какое-то значение в примере длиннее 255 символов, так что таблицу можно создать и в MySQL.
  • Атрибуты в snake_case. Когда ключ JSON отличается (publishedAt, home-url), исходный ключ передаётся как имя колонки: mapped_column("publishedAt", ...). Ключевые слова Python и metadata получают _ на конце.
  • Nullable-колонки помимо nullable=True аннотируются как Mapped[str | None].
  • Первичный ключ — Integer, который автоинкрементируется и в SQLite; строковый id в JSON становится ключом String(255), а большой целочисленный id использует BigInteger().with_variant(Integer, "sqlite").

Сценарии использования

Модели хранения для эндпоинтов FastAPI

Если у вас уже есть пример JSON запроса для схемы Pydantic, сгенерируйте модель SQLAlchemy из того же JSON и сразу пишите цепочку session.add(Book(**payload)).

Автогенерация миграций Alembic

Как только модель зарегистрирована в Base.metadata, alembic revision --autogenerate создаёт по этому классу миграцию с create_table.

Примечания и ограничения

  • Аннотациям str | None нужен Python 3.10+. В старых версиях пишите Optional[str] с from typing import Optional.
  • __tablename__ в верхнем регистре (BOOK). В PostgreSQL его тогда придётся брать в кавычки в сыром SQL, поэтому многие проекты меняют его на books.
  • С Flask-SQLAlchemy наследуйтесь от db.Model вместо сгенерированного Base.
  • Float — двоичная плавающая точка; для цен используйте Numeric(10, 2) с Decimal.

Частые вопросы

Почему id использует Integer, а не BigInteger?

SQLite автоинкрементирует только колонку, объявленную точно как INTEGER PRIMARY KEY, поэтому Integer обеспечивает одинаковое поведение в локальных тестах и на продакшене. Ключ переключается на BigInteger с вариантом для SQLite, только если в ваших данных уже есть id больше 32 бит.

Есть ли настройка схемы (__table_args__)?

Нет. Таблица попадает в схему подключения по умолчанию. Чтобы использовать другую схему PostgreSQL, добавьте __table_args__ = {"schema": "billing"} сами.

Можно ли получить синтаксис Column() из SQLAlchemy 1.4?

Вывод только в стиле 2.0 (Mapped, mapped_column, DeclarativeBase). Для 1.4 используйте declarative_base() и перепишите каждую строку в виде title = Column(String(255), nullable=False).