📣

TiDB Cloud Serverless が
Starter
に変わりました!このページは自動翻訳されたものです。
原文はこちらからご覧ください。

PyMySQLでTiDBに接続する

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

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

  • 環境を設定します。
  • PyMySQL を使用して TiDB クラスターに接続します。
  • アプリケーションをビルドして実行します。オプションで、基本的なCRUD操作のサンプルコードスニペットもご利用いただけます。

注記:

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

前提条件

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

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 クラスターに接続します。

    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='{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)

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

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

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

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

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

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

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

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

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

    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 pymysql_example.py
    2. 期待出力.txtチェックして、出力が一致するかどうかを確認します。

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

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

    完全なサンプル コードとその実行方法については、 tidb-samples/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 ステートメントの代わりにデータ オブジェクトを使用してデータを操作します。

    次のステップ

    ヘルプが必要ですか?

    不和またはスラック 、あるいはサポートチケットを送信するについてコミュニティに質問してください。

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