テーブルの作成
SQLModelでは、Pythonのクラスを定義することでデータベースのテーブル構造を表現します。このクラスをテーブルモデルと呼びます。基本的な構文は以下のとおりです。
from typing import Optional
from sqlmodel import SQLModel, Field
class モデル名(SQLModel, table=True):
id: Optional[int] = Field(default=None, primary_key=True)
フィールド名: 型
SQLModelを継承し、table=Trueを指定することで、このクラスがデータベースのテーブルに対応するモデルであることを示します。テーブルモデルを定義した後、create_engine()でエンジン(データベースへの接続を管理するオブジェクト)を作成し、SQLModel.metadata.create_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)
print("テーブル users を作成しました")
コードを解説します。
class User(SQLModel, table=True):
__tablename__ = "users"
id: Optional[int] = Field(default=None, primary_key=True)
name: str = Field(max_length=10)
age: int
この後作成するusersテーブルと同じ構成のテーブルモデルを定義しています。各要素の意味は以下のとおりです。
| 要素 | 説明 |
|---|---|
SQLModel, table=True |
データベースのテーブルに対応するモデルであることを示す |
__tablename__ = "users" |
対応するテーブル名を指定する |
id: Optional[int] |
主キー。Noneを許容するのは、新規作成時にはまだIDが割り振られていないため |
Field(primary_key=True) |
このフィールドが主キーであることを示す |
Field(max_length=10) |
文字列の最大長を10文字に制限する(MySQLのVARCHAR(10)に相当) |
| 📝 table=Trueの意味 |
|---|
table=Trueを指定したクラスは、データベースのテーブルに対応する「テーブルモデル」になります。table=Trueを指定しないクラスは、テーブルには対応せず、データの構造やバリデーション(入力チェック)のみを定義するモデルとして機能します。この違いは次の章で活用します。 |
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")
os.getenv()で.envファイルに定義した環境変数を読み込んでいます。第1引数が環境変数名、第2引数が環境変数が見つからなかった場合のデフォルト値です。load_dotenv()によって.envファイルの内容が環境変数として読み込まれているため、os.getenv("DB_HOST")で.envに記載したlocalhostが取得されます。
DATABASE_URL = f"mysql+pymysql://{DB_USER}:{DB_PASSWORD}@{DB_HOST}/{DB_NAME}"
engine = create_engine(DATABASE_URL)
エンジンは、データベースへの接続を管理するオブジェクトです。create_engine()に接続URLを渡して作成します。接続URLはmysql+pymysql://から始まり、ユーザ名、パスワード、ホスト名、データベース名を指定します。
| 📝 接続URLの形式 |
|---|
SQLModelの接続URLは、前の章のmysql.connector.connect(host=..., user=..., password=..., database=...)に相当します。mysql+pymysqlの部分は「MySQLデータベースにPyMySQLドライバで接続する」という意味です。 |
SQLModel.metadata.create_all(engine)
create_all()は、table=Trueが指定されたすべてのモデルに対応するテーブルを、データベースに自動的に作成します。テーブルがすでに存在する場合はスキップされます。
| 💡 ポイント |
|---|
前の章ではcursor.execute("CREATE TABLE users ...")のようにSQLを手動で記述していました。SQLModelでは、Pythonのクラス定義がそのままテーブル定義となり、create_all()で自動的にテーブルが作成されます。 |
2. Pythonの実行確認
以下のコマンドで、Python がインストールされていることを確認します。
Windowsの場合:
python --version
以下のように Python のバージョンが表示されれば、インストールは確認できています。
Python 3.x.x
Macの場合:
python3 --version
以下のように Python のバージョンが表示されれば、インストールは確認できています。
Python 3.x.x
バージョンが表示されない場合は、Pythonのインストール を先に実施してください。
インストールが確認できたら、main.py を実行します。
python main.py
以下の出力が表示されれば成功です。
テーブル users を作成しました
3. MySQLで確認
MySQLに接続して、テーブルが作成されているか確認してみましょう。
mysql -u root -p -e "SHOW TABLES FROM sqlmodel_testdb;"
パスワードを入力すると、以下のようにテーブルの一覧が表示されます。usersが含まれていれば成功です。
+----------------------------+
| Tables_in_sqlmodel_testdb |
+----------------------------+
| users |
+----------------------------+
| 💡 ポイント |
|---|
create_engine()にecho=Trueを指定すると、SQLModelが内部で実行するSQLがターミナルに出力されます。学習中はecho=Trueにしておくと、ORMがどのようなSQLを生成しているかを確認できます。 |