DjangoでTiDBに接続する

TiDBはMySQL互換のデータベースであり、Django強力なオブジェクトリレーショナルマッパー（ORM）ライブラリを含む、Python向けの人気の高いWebフレームワークです。

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

• 環境をセットアップしてください。
• Djangoを使用して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-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に接続してください。

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

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

python manage.py migrate

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

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

   python manage.py runserver
   

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

   python manage.py runserver 8080
   

2. アプリケーションにアクセスするには、ブラウザを開いてhttp://localhost:8000/にアクセスしてください。サンプルアプリケーションでは、以下の操作が可能です。

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

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

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

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

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_port} 、 ${tidb_user} 、 ${tidb_password} 、 ${tidb_db_name} 、および${ca_path} 、TiDBの実際の値に置き換える必要があります。

データモデルを定義する

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認定資格を取得します。

お困りですか？

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