Sequelize で TiDB に接続する

TiDB は MySQL 互換のデータベースであり、Node.js 用の人気のある ORM フレームワークです続編

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

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

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

前提条件

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

Node.js 18以降。
ギット。
TiDB クラスター。

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

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

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

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

注記
完全なコードスニペットと実行手順については、 tidb-samples/tidb-nodejs-sequelize-クイックスタート GitHub リポジトリを参照してください。

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

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

git clone git@github.com:tidb-samples/tidb-nodejs-sequelize-quickstart.git
cd tidb-nodejs-sequelize-quickstart

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

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

npm install

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

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

TiDB Cloud Serverless
TiDB Cloud Dedicated
TiDB Self-Managed

クラスターページに移動し、ターゲットクラスターの名前をクリックして概要ページに移動します。
右上隅の「接続」をクリックします。接続ダイアログが表示されます。
接続ダイアログの構成が動作環境と一致していることを確認します。
- 接続タイプはPublicに設定されています
- ブランチはmainに設定されています
- 接続先がGeneralに設定されています
- オペレーティングシステムは環境に適合します。
注記
Node.js アプリケーションでは、TLS (SSL) 接続を確立するときに Node.js がデフォルトで組み込みのMozilla CA証明書使用するため、SSL CA 証明書を提供する必要はありません。
ランダムなパスワードを作成するには、 「パスワードの生成」をクリックします。
ヒント
以前にパスワードを生成したことがある場合は、元のパスワードを使用するか、 「パスワードのリセット」をクリックして新しいパスワードを生成することができます。
次のコマンドを実行して.env.exampleコピーし、名前を.envに変更します。
```
cp .env.example .env
```
.envファイルを編集し、環境変数を次のように設定し、接続ダイアログで対応するプレースホルダー{}接続パラメータに置き換えます。
```
TIDB_HOST='{host}'
TIDB_PORT='4000'
TIDB_USER='{user}'
TIDB_PASSWORD='{password}'
TIDB_DB_NAME='test'
TIDB_ENABLE_SSL='true'
```
.envファイルを保存します。

クラスターページに移動し、ターゲットクラスターの名前をクリックして概要ページに移動します。
右上隅の「接続」をクリックします。接続ダイアログが表示されます。
接続ダイアログで、 [接続タイプ]ドロップダウンリストから[パブリック]を選択し、 [CA 証明書]をクリックして CA 証明書をダウンロードします。
IP アクセスリストをまだ設定していない場合は、 「IP アクセスリストの設定」をクリックするか、手順IPアクセスリストを設定するに従って、最初の接続の前に設定してください。
TiDB Cloud Dedicatedは、パブリック接続タイプに加えて、プライベートエンドポイントとVPCピアリング接続タイプもサポートしています。詳細については、 TiDB Cloud専用クラスタに接続するご覧ください。
次のコマンドを実行して.env.exampleコピーし、名前を.envに変更します。
```
cp .env.example .env
```
.envファイルを編集し、環境変数を次のように設定し、接続ダイアログで対応するプレースホルダー{}接続パラメータに置き換えます。
```
TIDB_HOST='{host}'
TIDB_PORT='4000'
TIDB_USER='{user}'
TIDB_PASSWORD='{password}'
TIDB_DB_NAME='test'
TIDB_ENABLE_SSL='true'
TIDB_CA_PATH='{path/to/ca}'
```
.envファイルを保存します。

次のコマンドを実行して.env.exampleコピーし、名前を.envに変更します。
```
cp .env.example .env
```
.envファイルを編集し、環境変数を次のように設定し、接続ダイアログで対応するプレースホルダー{}接続パラメータに置き換えます。
```
TIDB_HOST='{host}'
TIDB_PORT='4000'
TIDB_USER='root'
TIDB_PASSWORD='{password}'
TIDB_DB_NAME='test'
```
TiDB をローカルで実行している場合、デフォルトのホストアドレスは127.0.0.1で、パスワードは空になります。
.envファイルを保存します。

ステップ4: サンプルアプリを実行する

サンプルコードを実行するには、次のコマンドを実行します。

npm start

**予想される出力（一部）:**

INFO (app/10117): Getting sequelize instance...
Executing (default): SELECT 1+1 AS result
Executing (default): DROP TABLE IF EXISTS `players`;
Executing (default): CREATE TABLE IF NOT EXISTS `players` (`id` INTEGER NOT NULL auto_increment  COMMENT 'The unique ID of the player.', `coins` INTEGER NOT NULL COMMENT 'The number of coins that the player had.', `goods` INTEGER NOT NULL COMMENT 'The number of goods that the player had.', `createdAt` DATETIME NOT NULL, `updatedAt` DATETIME NOT NULL, PRIMARY KEY (`id`)) ENGINE=InnoDB;
Executing (default): SHOW INDEX FROM `players`
Executing (default): INSERT INTO `players` (`id`,`coins`,`goods`,`createdAt`,`updatedAt`) VALUES (1,100,100,'2023-08-31 09:10:11','2023-08-31 09:10:11'),(2,200,200,'2023-08-31 09:10:11','2023-08-31 09:10:11'),(3,300,300,'2023-08-31 09:10:11','2023-08-31 09:10:11'),(4,400,400,'2023-08-31 09:10:11','2023-08-31 09:10:11'),(5,500,500,'2023-08-31 09:10:11','2023-08-31 09:10:11');
Executing (default): SELECT `id`, `coins`, `goods`, `createdAt`, `updatedAt` FROM `players` AS `players` WHERE `players`.`coins` > 300;
Executing (default): UPDATE `players` SET `coins`=?,`goods`=?,`updatedAt`=? WHERE `id` = ?
Executing (default): DELETE FROM `players` WHERE `id` = 6

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

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

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

TiDBに接続する

次のコードは、環境変数で定義されたオプションを使用して TiDB への接続を確立します。

// src/lib/tidb.ts
import { Sequelize } from 'sequelize';

export function initSequelize() {
  return new Sequelize({
    dialect: 'mysql',
    host: process.env.TIDB_HOST || 'localhost',     // TiDB host, for example: {gateway-region}.aws.tidbcloud.com
    port: Number(process.env.TIDB_PORT) || 4000,    // TiDB port, default: 4000
    username: process.env.TIDB_USER || 'root',      // TiDB user, for example: {prefix}.root
    password: process.env.TIDB_PASSWORD || 'root',  // TiDB password
    database: process.env.TIDB_DB_NAME || 'test',   // TiDB database name, default: test
    dialectOptions: {
      ssl:
        process.env?.TIDB_ENABLE_SSL === 'true'     // (Optional) Enable SSL
          ? {
              minVersion: 'TLSv1.2',
              rejectUnauthorized: true,
              ca: process.env.TIDB_CA_PATH          // (Optional) Path to the custom CA certificate
                ? readFileSync(process.env.TIDB_CA_PATH)
                : undefined,
            }
          : null,
    },
}

export async function getSequelize() {
  if (!sequelize) {
    sequelize = initSequelize();
    try {
      await sequelize.authenticate();
      logger.info('Connection has been established successfully.');
    } catch (error) {
      logger.error('Unable to connect to the database:');
      logger.error(error);
      throw error;
    }
  }
  return sequelize;
}

データを挿入する

次のクエリは、 Playersつのレコードを作成し、 Playersオブジェクトを返します。

logger.info('Creating a new player...');
const newPlayer = await playersModel.create({
  id: 6,
  coins: 600,
  goods: 600,
});
logger.info('Created a new player.');
logger.info(newPlayer.toJSON());

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

クエリデータ

次のクエリは、コインが300より大きいPlayersというレコードを 1 つ返します。

logger.info('Reading all players with coins > 300...');
const allPlayersWithCoinsGreaterThan300 = await playersModel.findAll({
  where: {
    coins: {
      [Op.gt]: 300,
    },
  },
});
logger.info('Read all players with coins > 300.');
logger.info(allPlayersWithCoinsGreaterThan300.map((p) => p.toJSON()));

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

データを更新する

次のクエリは、セクションデータを挿入するで作成された ID 6のPlayersにコイン700と商品700を設定します。

logger.info('Updating the new player...');
await newPlayer.update({ coins: 700, goods: 700 });
logger.info('Updated the new player.');
logger.info(newPlayer.toJSON());

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

データを削除する

次のクエリは、セクションデータを挿入するで作成された ID 6のPlayerレコードを削除します。

logger.info('Deleting the new player...');
await newPlayer.destroy();
const deletedNewPlayer = await playersModel.findByPk(6);
logger.info('Deleted the new player.');
logger.info(deletedNewPlayer?.toJSON());

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

次のステップ

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

ヘルプが必要ですか?

不和またはスラック、あるいはサポートチケットを送信するについてコミュニティに質問してください。