プロジェクトの準備
SQLModelと、MySQLに接続するためのドライバであるPyMySQLをインストールします。
1. パッケージのインストール
SQLModelと、MySQLに接続するためのドライバであるPyMySQLをインストールします。
Windowsの場合:
pip install sqlmodel pymysql python-dotenv
Macの場合:
pip3 install sqlmodel pymysql python-dotenv
| 📝 PyMySQLとは |
|---|
PyMySQLは、PythonからMySQLに接続するためのドライバです。前の章で使用したmysql-connector-pythonと同じ役割を持ちますが、SQLModel(SQLAlchemy)ではPyMySQLがよく使われます。 |
| ⚠️ 「which is not on PATH」という警告が出る場合 |
|---|
WARNING: The script dotenv is installed in '...' which is not on PATH.という警告は、python-dotenvパッケージに付属するコマンドラインツールのインストール先がPATHに含まれていないことを意味します。本章ではコマンドラインツールは使用しないため、この警告は無視して問題ありません。 |
| ⚠️ 「You are using pip version ...」という警告が出る場合 |
|---|
WARNING: You are using pip version X.X.X; however, version Y.Y.Y is available.という警告は、pip自体のバージョンが古いことを意味します。パッケージのインストールは正常に完了しているため、本章には影響ありません。 |
2. フォルダとファイルの作成
本章では、まず任意の場所にsqlmodel-practiceフォルダを作成します。
sqlmodel-practice/ ← このフォルダを作成
作成したフォルダをVisual Studio Codeで開きます。Visual Studio Codeのメニューから「ファイル」→「フォルダーを開く」を選択し、作成したフォルダを開いてください。
main.pyを作成します。Visual Studio Codeのエクスプローラーでsqlmodel-practiceフォルダを右クリックし、「新しいファイル」を選択してmain.pyという名前で作成してください。
sqlmodel-practice/
└── main.py ← このファイルを作成
次に、環境変数を管理するための.envファイルを作成します。.envファイルは、データベースの接続情報(ホスト名、ユーザ名、パスワードなど)をコードから分離して管理するためのファイルです。接続情報をコードに直接記述すると、パスワードなどの機密情報がソースコードに含まれてしまうため、.envファイルに外出しするのが一般的です。sqlmodel-practiceフォルダ内に.envという名前でファイルを作成します。
sqlmodel-practice/
├── main.py
└── .env ← このファイルを作成
作成したファイルに以下の内容を記述して保存します。
DB_HOST=localhost
DB_USER=root
DB_PASSWORD=your_password
DB_NAME=sqlmodel_testdb
| 💡 ポイント |
|---|
DB_PASSWORDには、MySQLのインストール時に設定したrootパスワードを指定してください。本章のコード例ではyour_passwordと記載していますが、ご自身のパスワードに置き換えてください。 |
3. データベースの作成
SQLModelではテーブルの作成はPythonコードから行えますが、データベース自体の作成はSQLModel(SQLAlchemy)のサポート外です。そのため、MySQL CLIからデータベースを作成します。
以下のコマンドで、MySQL がインストールされていることを確認します。
mysql --version
以下のように MySQL のバージョンが表示されれば、インストールは確認できています。
mysql Ver 8.0.xx for macos on arm64 (MySQL Community Server - GPL)
バージョンが表示されない場合は、MySQLのインストール を先に実施してください。
インストールが確認できたら、以下のコマンドでデータベースを作成します。
mysql -u root -p -e "CREATE DATABASE sqlmodel_testdb;"
パスワードを入力すると、データベースsqlmodel_testdbが作成されます。データベースが正しく作成されたことを確認します。
mysql -u root -p -e "SHOW DATABASES;"
パスワードを入力すると、データベースの一覧が表示されます。
+--------------------+
| Database |
+--------------------+
| information_schema |
| mysql |
| performance_schema |
| sqlmodel_testdb |
| sys |
+--------------------+
一覧にsqlmodel_testdbが含まれていれば、データベースの作成は成功です。
| 📝 なぜデータベースだけ手動で作成するのか |
|---|
| ORMは「テーブルの作成・操作」を担当するツールであり、「データベース(スキーマ)の作成」はデータベースサーバの管理操作にあたります。SQLModel(SQLAlchemy)は既存のデータベースに対してテーブルを作成・操作する機能を提供しますが、データベース自体の作成は範囲外です。 |