peeweeを使用してTiDBに接続します。

TiDBはMySQL互換のデータベースであり、PythonはPythonで人気のPeeweeリレーショナルマッパー（ORM）です。

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

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

前提条件

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

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

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

• (推奨) TiDB Cloud Starterインスタンスを作成する。
• ローカルテスト用のTiDB Self-Managedクラスタをデプロイまたは本番のTiDB Self-Managedクラスタをデプロイ

TiDBに接続するには、サンプルアプリを実行してください。

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

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

サンプルコードリポジトリをクローンするには、ターミナルウィンドウで以下のコマンドを実行してください。

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

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

サンプルアプリに必要なパッケージ（peeweeとPyMySQLを含む）をインストールするには、以下のコマンドを実行してください。

pip install -r requirements.txt

PyMySQLを使う理由とは？

peeweeは、複数のデータベースを扱うORMライブラリです。データベースの高レベルな抽象化を提供することで、開発者がよりオブジェクト指向的な方法でSQL文を記述できるように支援します。ただし、peeweeにはデータベースドライバは含まれていません。データベースに接続するには、データベースドライバをインストールする必要があります。このサンプルアプリケーションでは、データベースドライバとしてPyMySQLを使用しています。PyMySQLは、TiDBと互換性があり、すべてのプラットフォームにインストール可能な、純粋なPython製のMySQLクライアントライブラリです。詳細については、 Peewee公式ドキュメントを参照してください。

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

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

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

1. サンプルコードを実行するには、以下のコマンドを実行してください。

   python peewee_example.py
   

2. Expected-Output.txtをチェックして、出力が一致するかどうかを確認してください。

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

以下のサンプルコードスニペットを参考に、独自のアプリケーション開発を完成させてください。

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

TiDBに接続する

from peewee import MySQLDatabase

def get_db_engine():
    config = Config()
    connect_params = {}
    if ${ca_path}:
        connect_params = {
            "ssl_verify_cert": True,
            "ssl_verify_identity": True,
            "ssl_ca": ${ca_path},
        }
    return MySQLDatabase(
        ${tidb_db_name},
        host=${tidb_host},
        port=${tidb_port},
        user=${tidb_user},
        password=${tidb_password},
        **connect_params,
    )

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

テーブルを定義する

from peewee import Model, CharField, IntegerField

db = get_db_engine()

class BaseModel(Model):
    class Meta:
        database = db

class Player(BaseModel):
    name = CharField(max_length=32, unique=True)
    coins = IntegerField(default=0)
    goods = IntegerField(default=0)

    class Meta:
        table_name = "players"

詳細については、 peewee ドキュメント: モデルとフィールドを参照してください。

データを挿入する

# Insert a single record
Player.create(name="test", coins=100, goods=100)

# Insert multiple records
Player.insert_many(
    [
        {"name": "test1", "coins": 100, "goods": 100},
        {"name": "test2", "coins": 100, "goods": 100},
    ]
).execute()

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

クエリデータ

# Query all records
players = Player.select()

# Query a single record
player = Player.get(Player.name == "test")

# Query multiple records
players = Player.select().where(Player.coins == 100)

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

データの更新

# Update a single record
player = Player.get(Player.name == "test")
player.coins = 200
player.save()

# Update multiple records
Player.update(coins=200).where(Player.coins == 100).execute()

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

データを削除する

# Delete a single record
player = Player.get(Player.name == "test")
player.delete_instance()

# Delete multiple records
Player.delete().where(Player.coins == 100).execute()

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

次のステップ

• Peeweeの使い方の詳細については、Peeweeのドキュメントをご覧ください。
• 開発者ガイド の データを挿入する、データの更新、データを削除する、単一表の読み取り、トランザクション、SQLパフォーマンス最適化 などの章を参考に、TiDB アプリケーション開発のベストプラクティスを学びます。
• プロフェッショナルなTiDB開発者向けコースコースを通じて学習し、試験に合格するとTiDB認定資格を取得します。

お困りですか？

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