SQLAlchemy で TiDB に接続する

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

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

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

注記：

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

前提条件

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

• Python 3.8以上 。
• ギット 。
• 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 サンプル/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()

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

次のステップ

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

助けが必要？

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