PyMySQLでTiDBに接続する

TiDB は MySQL 互換のデータベースであり、 pyMySQL の Python 用の人気のあるオープンソースドライバーです。

このチュートリアルでは、TiDB と PyMySQL を使用して次のタスクを実行する方法を学習します。

環境を設定します。
PyMySQL を使用して TiDB クラスターに接続します。
アプリケーションをビルドして実行します。オプションで、基本的な CRUD 操作のサンプルコードスニペットを見つけることができます。

注記：
このチュートリアルは、 TiDB Cloud Serverless、 TiDB Cloud Dedicated、および TiDB Self-Managed クラスターで機能します。

前提条件

このチュートリアルを完了するには、次のものが必要です。

Python 3.8以上。
ギット。
TiDB クラスター。

TiDB クラスターがない場合は、次のように作成できます。

(推奨) TiDB Cloud Serverless クラスターの作成に従って、独自のTiDB Cloudクラスターを作成します。
ローカルテストTiDBクラスタをデプロイまたは本番のTiDBクラスタをデプロイに従ってローカルクラスターを作成します。

サンプルアプリを実行してTiDBに接続する

このセクションでは、サンプルアプリケーションコードを実行して TiDB に接続する方法を示します。

ステップ1: サンプルアプリのリポジトリをクローンする

サンプルコードリポジトリを複製するには、ターミナルウィンドウで次のコマンドを実行します。

git clone https://github.com/tidb-samples/tidb-python-pymysql-quickstart.git
cd tidb-python-pymysql-quickstart

ステップ2: 依存関係をインストールする

次のコマンドを実行して、サンプルアプリに必要なパッケージ (PyMySQL を含む) をインストールします。

pip install -r requirements.txt

ステップ3: 接続情報を構成する

選択した TiDB デプロイメントオプションに応じて、TiDB クラスターに接続します。

クラスターページに移動し、ターゲットクラスターの名前をクリックして概要ページに移動します。
右上隅の「接続」をクリックします。接続ダイアログが表示されます。
接続ダイアログの構成が動作環境と一致していることを確認します。
- 接続タイプはPublicに設定されています
- ブランチはmainに設定されています
- 接続先はGeneralに設定されています
- オペレーティングシステムは環境に適合します。
ヒント：
プログラムが Windows Subsystem for Linux (WSL) で実行されている場合は、対応する Linux ディストリビューションに切り替えます。
ランダムなパスワードを作成するには、 「パスワードの生成」をクリックします。
ヒント：
以前にパスワードを作成したことがある場合は、元のパスワードを使用するか、 「パスワードのリセット」をクリックして新しいパスワードを生成することができます。
次のコマンドを実行して.env.exampleコピーし、名前を.envに変更します。
```
cp .env.example .env
```

対応する接続文字列をコピーして.envファイルに貼り付けます。例の結果は次のようになります。

TIDB_HOST='{host}'  # e.g. gateway01.ap-northeast-1.prod.aws.tidbcloud.com
TIDB_PORT='4000'
TIDB_USER='{user}'  # e.g. xxxxxx.root
TIDB_PASSWORD='{password}'
TIDB_DB_NAME='test'
CA_PATH='{ssl_ca}'  # e.g. /etc/ssl/certs/ca-certificates.crt (Debian / Ubuntu / Arch)

プレースホルダー{}を、接続ダイアログから取得した接続パラメータに必ず置き換えてください。

.envファイルを保存します。

クラスターページに移動し、ターゲットクラスターの名前をクリックして概要ページに移動します。
右上隅の「接続」をクリックします。接続ダイアログが表示されます。
接続ダイアログで、 [接続タイプ]ドロップダウンリストから[パブリック]を選択し、 [CA 証明書]をクリックして CA 証明書をダウンロードします。
IP アクセスリストを設定していない場合は、 「IP アクセスリストの設定」をクリックするか、手順IPアクセスリストを構成するに従って最初の接続の前に設定してください。
TiDB Dedicated は、パブリック接続タイプに加えて、プライベートエンドポイントとVPC ピアリング接続タイプもサポートしています。詳細については、 TiDB専用クラスタに接続するを参照してください。
次のコマンドを実行して.env.exampleコピーし、名前を.envに変更します。
```
cp .env.example .env
```
対応する接続文字列をコピーして.envファイルに貼り付けます。例の結果は次のようになります。
```
TIDB_HOST='{host}'  # e.g. tidb.xxxx.clusters.tidb-cloud.com
TIDB_PORT='4000'
TIDB_USER='{user}'  # e.g. root
TIDB_PASSWORD='{password}'
TIDB_DB_NAME='test'
CA_PATH='{your-downloaded-ca-path}'
```
プレースホルダー{}を接続ダイアログから取得した接続パラメータに置き換え、 CA_PATH前の手順でダウンロードした証明書パスで構成してください。
.envファイルを保存します。

次のコマンドを実行して.env.exampleコピーし、名前を.envに変更します。
```
cp .env.example .env
```
対応する接続文字列をコピーして.envファイルに貼り付けます。例の結果は次のようになります。
```
TIDB_HOST='{tidb_server_host}'
TIDB_PORT='4000'
TIDB_USER='root'
TIDB_PASSWORD='{password}'
TIDB_DB_NAME='test'
```
プレースホルダー{}を接続パラメータに置き換え、 CA_PATH行を削除してください。TiDB をローカルで実行している場合、デフォルトのホストアドレスは127.0.0.1で、パスワードは空です。
.envファイルを保存します。

ステップ4: コードを実行して結果を確認する

サンプルコードを実行するには、次のコマンドを実行します。
```
python pymysql_example.py
```
予想される出力.txtをチェックして、出力が一致するかどうかを確認します。

サンプルコードスニペット

次のサンプルコードスニペットを参照して、独自のアプリケーション開発を完了することができます。

完全なサンプルコードとその実行方法については、 tidb サンプル/tidb-python-pymysql-クイックスタートリポジトリを参照してください。

TiDBに接続する

from pymysql import Connection
from pymysql.cursors import DictCursor


def get_connection(autocommit: bool = True) -> Connection:
    config = Config()
    db_conf = {
        "host": ${tidb_host},
        "port": ${tidb_port},
        "user": ${tidb_user},
        "password": ${tidb_password},
        "database": ${tidb_db_name},
        "autocommit": autocommit,
        "cursorclass": DictCursor,
    }

    if ${ca_path}:
        db_conf["ssl_verify_cert"] = True
        db_conf["ssl_verify_identity"] = True
        db_conf["ssl_ca"] = ${ca_path}

    return pymysql.connect(**db_conf)

この関数を使用する場合は、 ${tidb_host} 、 ${tidb_port} 、 ${tidb_user} 、 ${tidb_password} 、 ${tidb_db_name} 、 ${ca_path}を TiDB クラスターの実際の値に置き換える必要があります。

データを挿入

with get_connection(autocommit=True) as conn:
    with conn.cursor() as cur:
        player = ("1", 1, 1)
        cursor.execute("INSERT INTO players (id, coins, goods) VALUES (%s, %s, %s)", player)

詳細についてはデータを挿入を参照してください。

クエリデータ

with get_connection(autocommit=True) as conn:
    with conn.cursor() as cur:
        cur.execute("SELECT count(*) FROM players")
        print(cursor.fetchone()["count(*)"])

詳細についてはクエリデータを参照してください。

データの更新

with get_connection(autocommit=True) as conn:
    with conn.cursor() as cur:
        player_id, amount, price="1", 10, 500
        cursor.execute(
            "UPDATE players SET goods = goods + %s, coins = coins + %s WHERE id = %s",
            (-amount, price, player_id),
        )

詳細についてはデータの更新を参照してください。

データを削除する

with get_connection(autocommit=True) as conn:
    with conn.cursor() as cur:
        player_id = "1"
        cursor.execute("DELETE FROM players WHERE id = %s", (player_id,))

詳細についてはデータを削除するを参照してください。

役に立つメモ

ドライバーまたは ORM フレームワークを使用していますか?

Python ドライバーはデータベースへの低レベルのアクセスを提供しますが、開発者は次の作業を行う必要があります。

データベース接続を手動で確立および解放します。
データベーストランザクションを手動で管理します。
データ行 ( pymysqlではタプルまたは辞書として表される) をデータオブジェクトに手動でマップします。

複雑な SQL 文を書く必要がない限り、開発にはSQLアルケミー、ピーウィー、 Django ORM などのORMフレームワークを使用することをお勧めします。次のことに役立ちます。

接続とトランザクションを管理するために定型コード減らします。
多数の SQL ステートメントの代わりにデータオブジェクトを使用してデータを操作します。

次のステップ

PyMySQLのドキュメントから PyMySQL の使い方を詳しく学びます。
開発者ガイドのデータを挿入、データの更新、データを削除する、単一テーブル読み取り、取引、 SQLパフォーマンスの最適化などの章で、 TiDB アプリケーション開発のベストプラクティスを学習します。
プロフェッショナルTiDB 開発者コースを通じて学び、試験に合格するとTiDB 認定獲得します。

ヘルプが必要ですか?

TiDB コミュニティ、またはサポートチケットを作成するについて質問します。