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

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

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

• 環境をセットアップしてください。
• SQLAlchemyを使用してTiDBに接続します。
• アプリケーションをビルドして実行してください。必要に応じて、基本的なCRUD操作のサンプルコードスニペットも利用できます。

注記：

このチュートリアルは、 TiDB Cloud Starter、 TiDB Cloud Essential、 TiDB Cloud Dedicated、およびTiDB Self-Managedに対応しています。

前提条件

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

• Python 3.8以降。
• Git 。
• TiDBクラスタ。

TiDBクラスタをお持ちでない場合は、以下の手順で作成できます。

• (推奨) TiDB Cloud Starterインスタンスを作成する。
• ローカルテスト用の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を使用しています。PyMySQLは、TiDBと互換性があり、すべてのプラットフォームにインストール可能な、純粋なPython製のMySQLクライアントライブラリです。

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

ステップ3：接続情報の設定

選択したTiDBのデプロイオプションに応じて、TiDBに接続してください。

ステップ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のドキュメント参照してください。
• 開発者ガイドデータを挿入するデータの更新、データを削除する、「SQL パフォーマンス最適化」などの章単一表の読み取り読んで、TiDB アプリケーション 取引SQLパフォーマンス最適化。
• プロフェッショナルなTiDB開発者向けコースコースを通じて学習し、試験に合格するとTiDB認定資格を取得します。

お困りですか？

• 不和or スラックコミュニティに質問してください。
• TiDB Cloudのサポートチケットを送信してください
• TiDB Self-Managedのサポートチケットを送信してください