I-convert ang JSON sa SQLAlchemy Schema!

Ipasok ang JSON at i-convert ito sa SQLAlchemy Schema! Sinusuportahan ang SQLAlchemy 2.0 ORM, Mapped, mapped_column, Flask, FastAPI.
JSON
Resulta
 

I-convert ang JSON sa SQLAlchemy Schema!

Kino-convert ang JSON sa isang SQLAlchemy 2.0 declarative model na handa nang patakbuhin: isang Base(DeclarativeBase) class, mga Mapped[...] type hint kasama ang mapped_column(), mga nullable flag, __tablename__ at isang Integer na primary key.

Magandang panimula ito kapag kailangang i-store ng isang FastAPI o Flask backend ang request JSON, o data na na-download mula sa ibang system, sa isang table na wala pang model.

Paano gamitin

  1. I-paste ang isang JSON object na kumakatawan sa isang row ng table. Kung may mga row na blangko ang ilang value, mag-paste ng ilang row bilang array para makuha ang nullable=True.
  2. Ilagay ang class name sa Pangalan ng model (default MyModel); ang __tablename__ ay ang pangalang iyon sa upper snake case.
  3. I-save ang output bilang models.py. Kung may Base na ang project mo, burahin ang na-generate at i-import ang sa iyo, para iisang metadata ang gamit ng lahat ng model.

Halimbawa

Input (JSON)
{
  "isbn": "978-0-13-468599-1",
  "title": "The Pragmatic Programmer",
  "pages": 352,
  "rating": 4.7,
  "available": true,
  "published_at": "2019-09-13"
}
Output (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)

Nananatiling String(255) ang isbn na may hyphen, nagiging Integer ang pages, Float ang rating, at ang published_at, na petsang walang oras, ay Date na may hint na date. Nandoon ang bawat value, kaya nullable=False ang lahat ng column.

Mga sinusuportahang feature

  • Dine-define ang class Base(DeclarativeBase): pass at ini-import lang ang mga SQLAlchemy type at datetime name na talagang ginagamit.
  • Type mapping: integer → Integer/int (BigInteger para sa malalaking value), decimal → Float, boolean → Boolean, YYYY-MM-DD → Date/date, date-time → DateTime/datetime, object at array → JSON na may dict/list.
  • String(255) ang mga string, o Text kapag may sample value na lampas sa 255 character, para magawa rin ang table sa MySQL.
  • snake_case ang mga attribute. Kapag iba ang JSON key (publishedAt, home-url), ipinapasa ang orihinal na key bilang column name: mapped_column("publishedAt", ...). Nilalagyan ng _ sa dulo ang mga Python keyword at ang metadata.
  • May hint na Mapped[str | None] ang mga nullable na column bukod sa nullable=True.
  • Integer ang primary key, na nag-a-autoincrement din sa SQLite; nagiging String(255) na key ang string na id sa JSON mo, at gumagamit ng BigInteger().with_variant(Integer, "sqlite") ang malaking integer na id.

Mga gamit

Mga persistence model para sa mga FastAPI endpoint

Kung may sample request JSON ka na para sa isang Pydantic schema, i-generate ang SQLAlchemy model mula sa parehong JSON at isulat agad ang daloy na session.add(Book(**payload)).

Mga autogenerated na Alembic migration

Kapag naka-register na ang model sa Base.metadata, gumagawa ang alembic revision --autogenerate ng create_table na migration mula sa class na ito.

Mga paalala at limitasyon

  • Kailangan ng Python 3.10+ para sa mga hint na str | None. Sa mga mas lumang bersyon, isulat ang Optional[str] gamit ang from typing import Optional.
  • Uppercase ang __tablename__ (BOOK). Dahil dito, kailangan itong i-quote ng PostgreSQL sa raw SQL, kaya pinapalitan ito ng maraming project ng books.
  • Sa Flask-SQLAlchemy, mag-inherit mula sa db.Model sa halip na sa na-generate na Base.
  • Binary floating point ang Float; gamitin ang Numeric(10, 2) kasama ang Decimal para sa mga presyo.

Mga madalas itanong

Bakit Integer at hindi BigInteger ang gamit ng id?

Sa SQLite, nag-a-autoincrement lang ang column na eksaktong naka-declare bilang INTEGER PRIMARY KEY, kaya sa Integer, pareho ang behavior ng local test at production. Kapag may mga id na lampas sa 32 bits na ang data mo, saka lang lumilipat ang key sa BigInteger na may SQLite variant.

May setting ba para sa schema (__table_args__)?

Wala. Napupunta ang table sa default schema ng connection. Para mag-target ng ibang PostgreSQL schema, ikaw na ang magdagdag ng __table_args__ = {"schema": "billing"}.

Puwede ba akong makakuha ng Column() syntax ng SQLAlchemy 1.4?

2.0 style lang ang output (Mapped, mapped_column, DeclarativeBase). Para sa 1.4, gamitin ang declarative_base() at isulat ulit ang bawat linya bilang title = Column(String(255), nullable=False).