TiDB Cloud
TiDB Self-Managed
Learning Center
お問い合わせ

mysqlclientでTiDBに接続する

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

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

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

注記：

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

前提条件

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

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 Cloud Serverless
  • TiDB Cloud Dedicated
  • TiDB Self-Managed

  1. クラスターページに移動し、ターゲット クラスターの名前をクリックして概要ページに移動します。

  2. 右上隅の「接続」をクリックします。接続ダイアログが表示されます。

  3. 接続ダイアログの構成が動作環境と一致していることを確認します。

    • 接続タイプはPublicに設定されています

    • ブランチはmainに設定されています

    • 接続先はGeneralに設定されています

    • オペレーティング システムは環境に適合します。

    ヒント：

    プログラムが Windows Subsystem for Linux (WSL) で実行されている場合は、対応する Linux ディストリビューションに切り替えます。

  4. ランダムなパスワードを作成するには、 「パスワードの生成」をクリックします。

    ヒント：

    以前にパスワードを作成したことがある場合は、元のパスワードを使用するか、 「パスワードのリセット」をクリックして新しいパスワードを生成することができます。

  5. 次のコマンドを実行して.env.exampleコピーし、名前を.envに変更します。

    cp .env.example .env

  6. 対応する接続文字列をコピーして.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 Serverless には安全な接続が必要です。 mysqlclient のssl_modeデフォルトでPREFERREDになっているため、 CA_PATH手動で指定する必要はありません。空のままにしておきます。ただし、 CA_PATH手動で指定する特別な理由がある場合は、 TiDB Cloud ServerlessへのTLS接続を参照して、さまざまなオペレーティング システムの証明書パスを取得できます。

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

  1. クラスターページに移動し、ターゲット クラスターの名前をクリックして概要ページに移動します。

  2. 右上隅の「接続」をクリックします。接続ダイアログが表示されます。

  3. 接続ダイアログで、 [接続タイプ]ドロップダウン リストから[パブリック]を選択し、 [CA 証明書]をクリックして CA 証明書をダウンロードします。

    IP アクセス リストを設定していない場合は、 「IP アクセス リストの設定」をクリックするか、手順IPアクセスリストを構成するに従って最初の接続の前に設定してください。

    TiDB Dedicated は、パブリック接続タイプに加えて、プライベートエンドポイントとVPC ピアリング接続タイプもサポートしています。詳細については、 TiDB専用クラスタに接続するを参照してください。

  4. 次のコマンドを実行して.env.exampleコピーし、名前を.envに変更します。

    cp .env.example .env

  5. 対応する接続文字列をコピーして.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前の手順でダウンロードした証明書パスで構成してください。

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

  1. 次のコマンドを実行して.env.exampleコピーし、名前を.envに変更します。

    cp .env.example .env

  2. 対応する接続文字列をコピーして.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で、パスワードは空です。

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

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

  1. サンプル コードを実行するには、次のコマンドを実行します。

    python mysqlclient_example.py

  2. 予想される出力.txtをチェックして、出力が一致するかどうかを確認します。

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

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

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

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

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

次のステップ

ヘルプが必要ですか?

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

このページは役に立ちましたか？