データの全件取得(READ)

次に、テーブルの全レコードを取得します。select()で取得するモデルを指定し、session.exec()で実行します。.all()で全件をリストとして取得できます。

with Session(engine) as session:
    結果 = session.exec(select(モデル名)).all()

1. Pythonコードの修正

実際に試してみましょう。main.pyを以下の内容に書き換えます。

import os
from typing import Optional

from dotenv import load_dotenv
from sqlmodel import Field, Session, SQLModel, create_engine, select

load_dotenv()


class User(SQLModel, table=True):
    __tablename__ = "users"
    id: Optional[int] = Field(default=None, primary_key=True)
    name: str = Field(max_length=10)
    age: int


DB_HOST = os.getenv("DB_HOST", "localhost")
DB_USER = os.getenv("DB_USER", "root")
DB_PASSWORD = os.getenv("DB_PASSWORD", "")
DB_NAME = os.getenv("DB_NAME", "sqlmodel_testdb")

DATABASE_URL = f"mysql+pymysql://{DB_USER}:{DB_PASSWORD}@{DB_HOST}/{DB_NAME}"
engine = create_engine(DATABASE_URL)

SQLModel.metadata.create_all(engine)

# データの全件取得
with Session(engine) as session:
    users = session.exec(select(User)).all()
    for user in users:
        print(f"id: {user.id}, name: {user.name}, age: {user.age}")

追加したコードを解説します。

    users = session.exec(select(User)).all()

select(User)はSQL文のSELECT * FROM usersに相当します。session.exec()でクエリを実行し、.all()で全件をリストとして取得しています。取得したデータはUserモデルのインスタンスとして返されるため、user.nameのように属性名でアクセスできます。

    for user in users:
        print(f"id: {user.id}, name: {user.name}, age: {user.age}")

前の章ではrow[0]、row[1]のようにインデックスでアクセスしていましたが、SQLModelではuser.id、user.nameのように属性名でアクセスできるため、コードの可読性が向上しています。

2. Pythonの実行確認

main.py を実行します。

python main.py

以下のように、usersテーブルの全レコードが表示されれば成功です。

id: 1, name: Suzuki, age: 20
id: 2, name: Tanaka, age: 30
id: 3, name: Suzuki, age: 25