Django で TiDB に接続する

TiDB は MySQL 互換のデータベースであり、 ジャンゴ強力なオブジェクト リレーショナル マッパー (ORM) ライブラリを含む Python 用の人気のある Web フレームワークです。

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

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

注記：

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

前提条件

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

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

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

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

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

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

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

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

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

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

次のコマンドを実行して、サンプル アプリに必要なパッケージ (Django、django-tidb、mysqlclient を含む) をインストールします。

pip install -r requirements.txt

mysqlclient のインストールで問題が発生した場合は、 mysqlclient 公式ドキュメントを参照してください。

django-tidbとは何ですか?

django-tidbは、TiDB と Django 間の互換性の問題を解決する Django 用の TiDB 方言です。

django-tidbをインストールするには、Django のバージョンと一致するバージョンを選択します。たとえば、 django==4.2.*を使用している場合はdjango-tidb==4.2.*をインストールします。マイナー バージョンは同じである必要はありません。最新のマイナー バージョンを使用することをお勧めします。

詳細についてはdjango-tidb リポジトリを参照してください。

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

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

• TiDB Cloud Serverless
• TiDB Cloud Dedicated
• TiDB Self-Managed

ステップ4: データベースを初期化する

プロジェクトのルート ディレクトリで、次のコマンドを実行してデータベースを初期化します。

python manage.py migrate

ステップ5: サンプルアプリケーションを実行する

1. アプリケーションを開発モードで実行します。

   python manage.py runserver
   

   アプリケーションはデフォルトでポート8000で実行されます。別のポートを使用するには、コマンドにポート番号を追加します。次に例を示します。

   python manage.py runserver 8080
   

2. アプリケーションにアクセスするには、ブラウザを開いてhttp://localhost:8000/に移動します。サンプル アプリケーションでは、次の操作を実行できます。

   • 新しいプレーヤーを作成します。
   • プレーヤーを一括作成します。
   • すべてのプレーヤーをビュー。
   • プレーヤーを更新します。
   • プレーヤーを削除します。
   • 2 人のプレイヤー間で商品を取引します。

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

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

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

TiDBに接続する

ファイルsample_project/settings.pyに次の設定を追加します。

DATABASES = {
    "default": {
        "ENGINE": "django_tidb",
        "HOST": ${tidb_host},
        "PORT": ${tidb_port},
        "USER": ${tidb_user},
        "PASSWORD": ${tidb_password},
        "NAME": ${tidb_db_name},
        "OPTIONS": {
            "charset": "utf8mb4",
        },
    }
}

TIDB_CA_PATH = ${ca_path}
if TIDB_CA_PATH:
    DATABASES["default"]["OPTIONS"]["ssl_mode"] = "VERIFY_IDENTITY"
    DATABASES["default"]["OPTIONS"]["ssl"] = {
        "ca": TIDB_CA_PATH,
    }

${tidb_host} ${tidb_user} ${tidb_password} ${tidb_db_name} ${tidb_port} TiDB クラスターの実際の値に置き換える必要${ca_path}あります。

データモデルを定義する

from django.db import models

class Player(models.Model):
    name = models.CharField(max_length=32, blank=False, null=False)
    coins = models.IntegerField(default=100)
    goods = models.IntegerField(default=1)
    created_at = models.DateTimeField(auto_now_add=True)
    updated_at = models.DateTimeField(auto_now=True)

詳細についてはDjango モデルを参照してください。

データを挿入

# insert a single object
player = Player.objects.create(name="player1", coins=100, goods=1)

# bulk insert multiple objects
Player.objects.bulk_create([
    Player(name="player1", coins=100, goods=1),
    Player(name="player2", coins=200, goods=2),
    Player(name="player3", coins=300, goods=3),
])

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

クエリデータ

# get a single object
player = Player.objects.get(name="player1")

# get multiple objects
filtered_players = Player.objects.filter(name="player1")

# get all objects
all_players = Player.objects.all()

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

データの更新

# update a single object
player = Player.objects.get(name="player1")
player.coins = 200
player.save()

# update multiple objects
Player.objects.filter(coins=100).update(coins=200)

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

データを削除する

# delete a single object
player = Player.objects.get(name="player1")
player.delete()

# delete multiple objects
Player.objects.filter(coins=100).delete()

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

次のステップ

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

ヘルプが必要ですか?

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