Tukarkan JSON kepada SQLAlchemy!

Masukkan JSON dan tukarkannya kepada SQLAlchemy! Menyokong SQLAlchemy 2.0 ORM, Mapped, mapped_column, Flask, FastAPI.
JSON
Hasil
 

Tukarkan JSON kepada SQLAlchemy!

Menukar JSON kepada model deklaratif SQLAlchemy 2.0 yang sedia dijalankan: kelas Base(DeclarativeBase), type hint Mapped[...] dengan mapped_column(), bendera nullable, __tablename__ dan primary key Integer.

Ia titik permulaan yang baik apabila backend FastAPI atau Flask perlu menyimpan JSON permintaan, atau data yang dimuat turun daripada sistem lain, ke dalam jadual yang belum ada model.

Cara menggunakan

  1. Tampal objek JSON yang mewakili satu baris jadual. Jika sesetengah baris mempunyai nilai kosong, tampal beberapa baris sebagai tatasusunan supaya nullable=True dikesan.
  2. Masukkan nama kelas dalam Nama model (lalai MyModel); __tablename__ ialah nama itu dalam upper snake case.
  3. Simpan output sebagai models.py. Jika projek anda sudah mempunyai Base, padam yang dijana dan import milik anda, supaya semua model berkongsi satu metadata.

Contoh

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)

isbn yang mengandungi sempang kekal String(255), pages menjadi Integer, rating menjadi Float, dan published_at, iaitu tarikh tanpa masa, menjadi Date dengan hint date. Setiap nilai ada, jadi semua lajur ialah nullable=False.

Ciri yang disokong

  • Mentakrifkan class Base(DeclarativeBase): pass dan hanya mengimport jenis SQLAlchemy dan nama datetime yang benar-benar digunakan.
  • Pemetaan jenis: integer → Integer/int (BigInteger untuk nilai besar), perpuluhan → Float, boolean → Boolean, YYYY-MM-DD → Date/date, tarikh-masa → DateTime/datetime, objek dan tatasusunan → JSON dengan dict/list.
  • Rentetan ialah String(255), atau Text apabila nilai sampel melebihi 255 aksara, supaya jadual boleh dicipta pada MySQL juga.
  • Atribut ditulis dalam snake_case. Apabila kunci JSON berbeza (publishedAt, home-url), kunci asal dihantar sebagai nama lajur: mapped_column("publishedAt", ...). Kata kunci Python dan metadata diberi _ di hujung.
  • Lajur yang boleh null diberi hint Mapped[str | None] di samping nullable=True.
  • Primary key ialah Integer, yang auto-increment pada SQLite juga; id rentetan dalam JSON anda menjadi kunci String(255), dan id integer yang besar menggunakan BigInteger().with_variant(Integer, "sqlite").

Kes penggunaan

Model persistence untuk endpoint FastAPI

Jika anda sudah ada sampel JSON permintaan untuk skema Pydantic, jana model SQLAlchemy daripada JSON yang sama dan terus tulis aliran session.add(Book(**payload)).

Migrasi Alembic yang dijana automatik

Setelah model didaftarkan pada Base.metadata, alembic revision --autogenerate menghasilkan migrasi create_table daripada kelas ini.

Nota dan had

  • Hint str | None memerlukan Python 3.10+. Pada versi lebih lama, tulis Optional[str] dengan from typing import Optional.
  • __tablename__ dalam huruf besar (BOOK). PostgreSQL kemudiannya memerlukan ia dipetik dalam SQL mentah, jadi banyak projek menukarnya kepada books.
  • Dengan Flask-SQLAlchemy, warisi daripada db.Model dan bukan Base yang dijana.
  • Float ialah titik terapung binari; gunakan Numeric(10, 2) dengan Decimal untuk harga.

Soalan lazim

Mengapa id menggunakan Integer dan bukan BigInteger?

SQLite hanya auto-increment lajur yang diisytiharkan tepat sebagai INTEGER PRIMARY KEY, jadi Integer memastikan ujian tempatan dan production berkelakuan sama. Hanya apabila data anda sudah mempunyai id melebihi 32 bit, kunci itu bertukar kepada BigInteger dengan varian SQLite.

Adakah tetapan skema (__table_args__)?

Tidak. Jadual dimasukkan ke skema lalai sambungan. Untuk menyasarkan skema PostgreSQL lain, tambah sendiri __table_args__ = {"schema": "billing"}.

Bolehkah saya mendapat sintaks Column() SQLAlchemy 1.4?

Output hanya dalam gaya 2.0 (Mapped, mapped_column, DeclarativeBase). Untuk 1.4, gunakan declarative_base() dan tulis semula setiap baris sebagai title = Column(String(255), nullable=False).