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

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

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

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

注記：

このチュートリアルは、TiDB サーバーレス、TiDB 専用、および TiDB セルフホスト クラスターで動作します。

前提条件

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

• Python 3.8以降 。
• ギット 。
• TiDB クラスター。

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

• (推奨) TiDB サーバーレスクラスターの作成に従って、独自のTiDB Cloudクラスターを作成します。
• ローカル テスト TiDB クラスターをデプロイまたは本番TiDB クラスターをデプロイに従ってローカル クラスターを作成します。

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

• (推奨) TiDB サーバーレスクラスターの作成に従って、独自のTiDB Cloudクラスターを作成します。
• ローカル テスト TiDB クラスターをデプロイまたは本番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 Serverless
• TiDB Dedicated
• TiDB Self-Hosted

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

1. 次のコマンドを実行してサンプル コードを実行します。

   python sqlalchemy_example.py
   

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

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

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

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

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()

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

次のステップ

• SQLAlchemy の詳しい使い方をSQLAlchemy のドキュメントから学びましょう。
• TiDB アプリケーション開発のSQLパフォーマンスの最適化プラクティスについて取引 、 開発者ガイドの章 ( データの挿入など) データを更新する参照データの削除 単一テーブルの読み取りください。
• プロフェッショナルとしてTiDB 開発者コースを学び、試験合格後にTiDB 認定獲得します。

助けが必要？

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

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