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

mysqlclient を使用して TiDB に接続する

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

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

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

注記：

このチュートリアルは、TiDB サーバーレス、TiDB 専用、および 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 Serverless
  • TiDB Dedicated
  • TiDB Self-Hosted

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

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

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

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

  3. 「どこからでもアクセスを許可」をクリックし、 「TiDB クラスター CA のダウンロード」をクリックして CA 証明書をダウンロードします。

    接続文字列の取得方法の詳細については、 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-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 ステートメントを記述する必要がない限り、開発にはSQLアルケミー 、 ピーウィー 、Django ORM などのORMフレームワークを使用することをお勧めします。それはあなたに役立ちます:

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

次のステップ

助けが必要？

不和またはサポートチケットを作成するについて質問してください。

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