MySQL Connector/Pythonを使用してTiDBに接続する

TiDB は MySQL 互換データベースであり、 MySQL Connector/Pythonは Python 用の公式 MySQL ドライバーです。

このチュートリアルでは、TiDBとMySQL Connector/Pythonを使用して以下のタスクを実行する方法を学ぶことができます。

• 環境をセットアップしてください。
• MySQL Connector/Pythonを使用してTiDBに接続します。
• アプリケーションをビルドして実行します。必要に応じて、基本的なCRUD操作のサンプルコードスニペットも利用できます。

前提条件

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

• Python 3.8以降。
• Git 。
• TiDBクラスタ。

TiDBクラスタをお持ちでない場合は、以下の手順で作成できます。

• (推奨) TiDB Cloud Starterインスタンスを作成する。
• ローカルテスト用のTiDB Self-Managedクラスタをデプロイまたは本番のTiDB Self-Managedクラスタをデプロイ

TiDBに接続するには、サンプルアプリを実行してください。

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

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

サンプルコードリポジトリをクローンするには、ターミナルウィンドウで以下のコマンドを実行してください。

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

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

サンプルアプリに必要なパッケージ（mysql-connector-pythonを含む）をインストールするには、以下のコマンドを実行してください。

pip install -r requirements.txt

ステップ3：接続情報の設定

選択したTiDBのデプロイオプションに応じて、TiDBに接続してください。

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

1. サンプルコードを実行するには、以下のコマンドを実行してください。

   python mysql_connector_example.py
   

2. Expected-Output.txtをチェックして、出力が一致するかどうかを確認してください。

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

以下のサンプルコードスニペットを参考に、独自のアプリケーション開発を完成させてください。

完全なサンプルコードと実行方法については、 tidb-samples/tidb-python-mysqlconnector-quickstartリポジトリを参照してください。

TiDBに接続する

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

    if ${ca_path}:
        db_conf["ssl_verify_cert"] = True
        db_conf["ssl_verify_identity"] = True
        db_conf["ssl_ca"] = ${ca_path}
    return mysql.connector.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(cur.fetchone()[0])

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

データの更新

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ドライバはデータベースへの低レベルアクセスを提供しますが、開発者には以下のことが必要となります。

• データベース接続を手動で確立および解放します。
• データベースのトランザクションを手動で管理します。
• データ行（ mysql-connector-pythonではタプルまたは辞書として表現されます）をデータオブジェクトに手動でマッピングします。

複雑なSQL文を書く必要がない限り、 SQLAlchemy 、 Peewee、Django ORMなどのORMフレームワークを使用して開発することをお勧めします。これにより、次のようなことが可能になります。

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

次のステップ

• mysql-connector-python の使用法の詳細についてはMySQL Connector/Python のドキュメントを参照してください。
• 開発者ガイド の データを挿入する、データの更新、データを削除する、単一表の読み取り、トランザクション、SQLパフォーマンス最適化 などの章を参考に、TiDB アプリケーション開発のベストプラクティスを学びます。
• プロフェッショナルなTiDB開発者向けコースコースを通じて学習し、試験に合格するとTiDB認定資格を取得します。

お困りですか？

• Discordor Slackコミュニティに質問してください。
• TiDB Cloudのサポートチケットを送信してください
• TiDB Self-Managedのサポートチケットを送信してください