メタデータの反映
SQLAlchemy はオブジェクト関係マッピング(ORM)として動作させることができます。これにより、データベーステーブルのレコードをインスタンス化可能なレコードとして扱うことができます。 この機能を使用するには、次の方法の1つを使って参照先のメタデータを反映する必要があります。
Note: 以下の例ではSQLAlchemy 1.4 を使用しています。
マッピングクラスを使用したデータのモデル化
"sqlalchemy.ext.declarative.declarative_base" を使用して、ORM でモデル化するテーブルのマッピングクラスを宣言します。 データモデル内の既知のテーブルは、以下の例に示すように、部分的または完全にモデル化されます。from sqlalchemy.ext.declarative import declarative_base Base = declarative_base() class "sales_db"."public".Orders(Base): __tablename__ = "\"sales_db\".\"public\".Orders" Id = Column(String, primary_key=True) ShipName = Column(String) ShipCity = Column(String)
自動でのメタデータの反映
手動でテーブルをマッピングする他に、SQLAlchemy は1つ以上のテーブルのメタデータを自動で見つけることができます。 データモデル全体でこれを行うには、automap_base を使用します。from sqlalchemy import MetaData from sqlalchemy.ext.automap import automap_base meta = MetaData() abase = automap_base(metadata=meta) abase.prepare(autoload_with=engine) "sales_db"."public".Orders = abase.classes."sales_db"."public".Orders
また、1つのテーブルの情報であればインスペクターを使用して反映することもできます。この方法で反映させる場合には、マップする特定のカラムのリストはオプションです。
from sqlalchemy import MetaData, Table from sqlalchemy import inspect meta = MetaData() insp = inspect(engine) "sales_db"."public".Orders_table = Table("\"sales_db\".\"public\".Orders", meta) insp.reflect_table("sales_db"."public".Orders_table, ["Id","ShipCity"])