Python で SQLAlchemy を使ってデータベースからデータを取得する

2024-04-02

SQLAlchemy クエリからテーブル名を取得する方法

概要

方法

tablename 属性を使用する

declarative_base クラスから派生したクラスで __tablename__ 属性を定義している場合、その属性を使用してテーブル名を取得することができます。

from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy.schema import Column
from sqlalchemy.types import Integer, String

Base = declarative_base()

class User(Base):
    __tablename__ = "users"  # テーブル名を指定

    id = Column(Integer, primary_key=True)
    name = Column(String)


query = session.query(User)

table_name = User.__tablename__

print(table_name)  # "users" と出力される

mapper 属性を使用する

Query オブジェクトの mapper 属性を使用して、関連するテーブル名を取得することができます。

query = session.query(User)

table_name = query.mapper.entity.name

print(table_name)  # "users" と出力される

info 属性を使用する

query = session.query(User)

info = query.info

table_name = info["table_name"]

print(table_name)  # "users" と出力される

inspect モジュールを使用する

sqlalchemy.inspect モジュールを使用して、テーブル名を含むデータベースのメタデータを取得することができます。

from sqlalchemy import inspect

engine = create_engine("sqlite:///database.sqlite")

inspector = inspect(engine)

table_name = inspector.get_table_names()[0]

print(table_name)  # "users" と出力される

上記の方法のいずれかを使用して、SQLAlchemy クエリからテーブル名を取得することができます。状況に応じて適切な方法を選択してください。

from sqlalchemy import create_engine, Column, Integer, String, ForeignKey
from sqlalchemy.orm import declarative_base, sessionmaker

Base = declarative_base()

class User(Base):
    __tablename__ = "users"

    id = Column(Integer, primary_key=True)
    name = Column(String)

class Address(Base):
    __tablename__ = "addresses"

    id = Column(Integer, primary_key=True)
    user_id = Column(Integer, ForeignKey("users.id"))
    address = Column(String)


engine = create_engine("sqlite:///database.sqlite")

Base.metadata.create_all(engine)

session = sessionmaker(bind=engine)()

# ユーザーと住所を取得するクエリ
query = session.query(User, Address).join(Address, User.id == Address.user_id)

# クエリ結果をループ処理
for user, address in query:
    print(f"ユーザー名: {user.name}")
    print(f"住所: {address.address}")


session.close()

このコードは、users テーブルと addresses テーブルを結合して、ユーザー名と住所を取得します。

実行方法

Python で以下のコードを実行します。
database.sqlite という名前の SQLite データベースが存在することを確認します。
データベースに users テーブルと addresses テーブルが存在することを確認します。

出力結果

ユーザー名: 山田太郎
住所: 東京都港区
ユーザー名: 佐藤花子
住所: 大阪府大阪市

補足

このサンプルコードは、基本的な使用方法を示すためのものです。実際のアプリケーションでは、必要に応じてコードを修正する必要があります。

SQLAlchemy クエリからテーブル名を取得するその他の方法

_from_objects メソッドを使用する

Query オブジェクトの _from_objects メソッドを使用して、クエリ対象のエンティティを取得することができます。エンティティには __tablename__ 属性があり、そこからテーブル名を取得できます。

query = session.query(User)

entity = query._from_objects()[0]

table_name = entity.__tablename__

print(table_name)  # "users" と出力される

text() メソッドを使用する

Query オブジェクトの text() メソッドを使用して、SQL クエリ文字列を取得することができます。SQL クエリ文字列からテーブル名を抽出することができます。

query = session.query(User)

sql = query.text()

table_name = re.findall(r"FROM\s+(\w+)\s+", sql)[0]

print(table_name)  # "users" と出力される

table 属性を使用する

query = session.query(User)

table = query.__table__

table_name = table.name

print(table_name)  # "users" と出力される

注意

上記の方法は、すべての状況で動作するとは限りません。詳細については、SQLAlchemy のドキュメントを参照してください。

sqlalchemy