📣

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

SQLAlchemy で TiDB に接続する

TiDB は MySQL 互換のデータベースであり、 SQLアルケミー人気の Python SQL ツールキットおよびオブジェクト リレーショナル マッパー (ORM) です。

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

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

注記:

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

前提条件

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

TiDB クラスターがない場合は、次のように作成できます。

サンプルアプリを実行してTiDBに接続する

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

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

サンプル コード リポジトリを複製するには、ターミナル ウィンドウで次のコマンドを実行します。

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

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

次のコマンドを実行して、サンプル アプリに必要なパッケージ (SQLAlchemy および PyMySQL を含む) をインストールします。

pip install -r requirements.txt

PyMySQL を使用する理由は何ですか?

SQLAlchemy は、複数のデータベースで動作する ORM ライブラリです。データベースの高レベルの抽象化を提供し、開発者がよりオブジェクト指向的な方法で SQL ステートメントを記述するのに役立ちます。ただし、SQLAlchemy にはデータベース ドライバーが含まれていません。データベースに接続するには、データベース ドライバーをインストールする必要があります。このサンプル アプリケーションでは、データベース ドライバーとして PyMySQL を使用します。これは、TiDB と互換性があり、すべてのプラットフォームにインストールできる純粋な Python MySQL クライアント ライブラリです。

mysqlクライアントmysql-コネクタ-pythonなどの他のデータベース ドライバーを使用することもできます。ただし、これらは純粋な Python ライブラリではないため、コンパイルには対応する C/C++ コンパイラと MySQL クライアントが必要です。詳細については、 SQLAlchemy 公式ドキュメントを参照してください。

ステップ3: 接続情報を構成する

選択した TiDB デプロイメント オプションに応じて、TiDB クラスターに接続します。

    注記:

    現在、 TiDB Cloud Serverless クラスターには制限があります。5 分間アクティブな接続がない場合、クラスターはシャットダウンし、すべての接続が閉じられます。そのため、 TiDB Cloud Serverless クラスターで SQLAlchemy を使用すると、プールされた接続でLost connection to MySQL server during queryMySQL Connection not availableなどのOperationalError発生する可能性があります。このエラーを回避するには、 pool_recycleパラメータを300に設定できます。詳細については、SQLAlchemy ドキュメントの切断への対処を参照してください。

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

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

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

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

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

    TiDBに接続する

    from sqlalchemy import create_engine, URL from sqlalchemy.orm import sessionmaker def get_db_engine(): connect_args = {} if ${ca_path}: connect_args = { "ssl_verify_cert": True, "ssl_verify_identity": True, "ssl_ca": ${ca_path}, } return create_engine( URL.create( drivername="mysql+pymysql", username=${tidb_user}, password=${tidb_password}, host=${tidb_host}, port=${tidb_port}, database=${tidb_db_name}, ), connect_args=connect_args, ) engine = get_db_engine() Session = sessionmaker(bind=engine)

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

    テーブルを定義する

    from sqlalchemy import Column, Integer, String from sqlalchemy.orm import declarative_base Base = declarative_base() class Player(Base): id = Column(Integer, primary_key=True) name = Column(String(32), unique=True) coins = Column(Integer) goods = Column(Integer) __tablename__ = "players"

    詳細についてはSQLAlchemyドキュメント: 宣言型によるクラスのマッピングを参照してください。

    データを挿入

    with Session() as session: player = Player(name="test", coins=100, goods=100) session.add(player) session.commit()

    詳細についてはデータを挿入を参照してください。

    クエリデータ

    with Session() as session: player = session.query(Player).filter_by(name == "test").one() print(player)

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

    データの更新

    with Session() as session: player = session.query(Player).filter_by(name == "test").one() player.coins = 200 session.commit()

    詳細についてはデータの更新を参照してください。

    データを削除する

    with Session() as session: player = session.query(Player).filter_by(name == "test").one() session.delete(player) session.commit()

    詳細についてはデータを削除するを参照してください。

    次のステップ

    ヘルプが必要ですか?

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

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