データの作成(CREATE)
テーブルの準備ができたので、次はレコードを追加します。SQLModelでは、セッションを使ってデータベースを操作します。セッションは、前の章におけるconnectionとcursorの両方の役割を担うオブジェクトです。
モデルのインスタンスを作成し、session.add()でセッションに追加した後、session.commit()で変更をデータベースに反映します。
with Session(engine) as session:
インスタンス = モデル名(フィールド名=値, ...)
session.add(インスタンス)
session.commit()
| 📝 セッションとは |
|---|
前の章では、connection = mysql.connector.connect(...) で接続を作成し、cursor = connection.cursor() でカーソルを取得して操作を行いました。SQLModelのSessionはこの2つの役割を1つにまとめたもので、データベースへの接続管理とSQL操作を統合して行います。with文を使うことで、ブロックを抜ける際にセッションが自動的に閉じられます。 |
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:
user1 = User(name="Suzuki", age=20)
user2 = User(name="Tanaka", age=30)
user3 = User(name="Suzuki", age=25)
session.add(user1)
session.add(user2)
session.add(user3)
session.commit()
print(f"作成されたユーザ: {user1.name}(ID: {user1.id})")
print(f"作成されたユーザ: {user2.name}(ID: {user2.id})")
print(f"作成されたユーザ: {user3.name}(ID: {user3.id})")
追加したコードを解説します。
with Session(engine) as session:
with文でSessionを作成しています。withブロックを抜ける際にセッションが自動的に閉じられるため、手動でクローズ処理を書く必要がありません。
user1 = User(name="Suzuki", age=20)
Userモデルのインスタンスを作成しています。この時点ではまだデータベースには保存されていません。
session.add(user1)
session.add()でインスタンスをセッションに追加しています。複数のインスタンスを追加する場合は、session.add()を複数回呼び出します。
session.commit()
session.commit()で、セッションに追加されたすべてのインスタンスがINSERT文として実行され、データベースに保存されます。前の章のconnection.commit()と同じ役割です。commit()を呼ばないと変更は反映されません。
print(f"作成されたユーザ: {user1.name}(ID: {user1.id})")
commit()の後は、user1.idのようにデータベースが自動付与したID(AUTO_INCREMENT)にアクセスできます。
2. Pythonの実行確認
main.py を実行します。
python main.py
以下のような出力が表示されれば成功です。
作成されたユーザ: Suzuki(ID: 1)
作成されたユーザ: Tanaka(ID: 2)
作成されたユーザ: Suzuki(ID: 3)
3. MySQLで確認
MySQLに接続して、データが正しく作成されているか確認します。
mysql -u root -p -e "SELECT * FROM sqlmodel_testdb.users;"
パスワードを入力すると、以下の結果が表示されます。
+----+--------+------+
| id | name | age |
+----+--------+------+
| 1 | Suzuki | 20 |
| 2 | Tanaka | 30 |
| 3 | Suzuki | 25 |
+----+--------+------+
Pythonから実行したINSERTが正しく反映されていることが確認できます。