📣

TiDB Cloud Premium はパブリックプレビュー中です。エンタープライズワークロード向けの無制限のスケーリング、即時の弾力性、高度なセキュリティを提供します。このページは自動翻訳されたものです。原文はこちらからご覧ください。

mysqlclientを使用してTiDBに接続します。

TiDBはMySQL互換のデータベースであり、 mysqlclientはPythonで広く使われているオープンソースのドライバです。

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

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

注記：
このチュートリアルは、 TiDB Cloud Starter、 TiDB Cloud Essential、 TiDB Cloud Premium、 TiDB Cloud Dedicated、およびTiDB Self-Managedに対応しています。

前提条件

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

Python 3.10以降。
Git 。
TiDBクラスタ。

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

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

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

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

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

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

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

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

pip install -r requirements.txt

インストールの問題が発生した場合は、 mysqlclient の公式ドキュメントを参照してください。

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

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

私のTiDBページに移動し、対象のTiDB Cloud StarterまたはEssentialインスタンスの名前をクリックして、概要ページに移動します。
右上隅の「接続」をクリックしてください。接続ダイアログが表示されます。
接続ダイアログの設定がご使用のオペレーティング環境と一致していることを確認してください。
- 接続タイプはPublicに設定されています。
- ブランチはmainに設定されています。
- Connect With はGeneralに設定されています。
- お使いの環境に合ったオペレーティングシステムを選択してください。
ヒント：
プログラムがWindows Subsystem for Linux（WSL）上で実行されている場合は、対応するLinuxディストリビューションに切り替えてください。
「パスワードを生成」をクリックすると、ランダムなパスワードが生成されます。
ヒント：
以前にパスワードを作成したことがある場合は、元のパスワードを使用するか、 「パスワードをリセット」をクリックして新しいパスワードを生成できます。
.env.exampleをコピーして.envに名前を変更するには、次のコマンドを実行します。
```
cp .env.example .env
```
対応する接続文字列.envファイルにコピー＆ペーストしてください。例は以下のとおりです。
```
TIDB_HOST='{gateway-region}.aws.tidbcloud.com'
TIDB_PORT='4000'
TIDB_USER='{prefix}.root'
TIDB_PASSWORD='{password}'
TIDB_DB_NAME='test'
CA_PATH=''
```
必ずプレースホルダー{}を、接続ダイアログから取得した接続パラメータに置き換えてください。
TiDB Cloud Starter は安全な接続を必要とします。mysqlclient のssl_modeはデフォルトでPREFERREDになっているため、 CA_PATH手動で指定する必要はありません。空欄のままにしてください。ただし、 CA_PATH手動で指定する必要がある特別な理由がある場合は、 TiDB Cloud StarterへのTLS接続を参照して、さまざまなオペレーティングシステムの証明書パスを取得してください。
.envファイルを保存します。

私のTiDBページに移動し、対象のTiDB Cloud Premiumインスタンスの名前をクリックして概要ページに移動します。
左側のナビゲーションペインで、 [設定] > [ネットワーク]をクリックします。
ネットワークのページで、 [パブリックエンドポイント**を有効にする]をクリックし、次に[IP アドレスの追加]**をクリックします。
クライアントのIPアドレスがアクセスリストに追加されていることを確認してください。
左側のナビゲーションペインで「概要」をクリックすると、インスタンスの概要ページに戻ります。
右上隅の「接続」をクリックしてください。接続ダイアログが表示されます。
接続ダイアログで、 「接続タイプ」ドロップダウンリストから「パブリック」を選択します。
- 公開エンドポイントがまだ有効化中であることを示すメッセージが表示された場合は、処理が完了するまでお待ちください。
- まだパスワードを設定していない場合は、ダイアログの「ルートパスワードを設定」をクリックしてください。
- サーバー証明書を確認する必要がある場合、または接続に失敗して認証局（CA）証明書が必要な場合は、 「CA証明書」をクリックしてダウンロードしてください。
- パブリック接続タイプに加えて、 TiDB Cloud Premium はプライベートエンドポイント接続をサポートします。詳細については、 AWS PrivateLink経由でTiDB Cloud Premiumに接続します。を参照してください。
.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=''
```
必ずプレースホルダー{}を、接続ダイアログから取得した接続パラメータに置き換えてください。
.envファイルを保存します。

私のTiDBページに移動し、対象のTiDB Cloud Dedicatedクラスタの名前をクリックして概要ページに移動します。
右上隅の「接続」をクリックしてください。接続ダイアログが表示されます。
接続ダイアログで、「接続タイプ」ドロップダウンリストから「パブリック」を選択し、 「CA証明書」をクリックしてCA証明書をダウンロードします。
IP アクセスリストを設定していない場合は、最初の接続の前に、 [IP アクセスリストの設定] をクリックするか、「IP アクセスリストを設定する」の手順に従ってIPアクセスリストを設定する。
TiDB Cloud Dedicated は、パブリック接続タイプに加えて、プライベートエンドポイントおよびVPC ピアリング接続タイプもサポートしています。詳細については、 TiDB Cloud Dedicatedクラスタに接続します参照してください。
.env.exampleをコピーして.envに名前を変更するには、次のコマンドを実行します。
```
cp .env.example .env
```
対応する接続文字列.envファイルにコピー＆ペーストしてください。例は以下のとおりです。
```
TIDB_HOST='{host}.clusters.tidb-cloud.com'
TIDB_PORT='4000'
TIDB_USER='{username}'
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 mysqlclient_example.py
```
期待される出力.txtをチェックして、出力が一致するかどうかを確認してください。

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

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

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

TiDBに接続する

def get_mysqlclient_connection(autocommit:bool=True) -> MySQLdb.Connection:
    db_conf = {
        "host": ${tidb_host},
        "port": ${tidb_port},
        "user": ${tidb_user},
        "password": ${tidb_password},
        "database": ${tidb_db_name},
        "autocommit": autocommit
    }

    if ${ca_path}:
        db_conf["ssl_mode"] = "VERIFY_IDENTITY"
        db_conf["ssl"] = {"ca": ${ca_path}}

    return MySQLdb.connect(**db_conf)

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

データを挿入する

with get_mysqlclient_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_mysqlclient_connection(autocommit=True) as conn:
    with conn.cursor() as cur:
        cur.execute("SELECT count(*) FROM players")
        print(cur.fetchone()[0])

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

データの更新

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

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

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

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

次のステップ

mysqlclientの使用法の詳細についてはmysqlclient のドキュメントご覧ください。
開発者ガイドデータを挿入するデータの更新、データを削除する、「SQL パフォーマンス最適化」などの章単一表の読み取り読んで、TiDB アプリケーション取引 SQLパフォーマンス最適化。
プロフェッショナルなTiDB開発者向けコースコースを通じて学習し、試験に合格するとTiDB認定資格を取得します。