TypeORM で TiDB に接続する

TiDB は MySQL 互換のデータベースであり、 タイプORM Node.js 用の人気のあるオープンソース ORM フレームワークです。

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

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

注記

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

前提条件

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

• Node.js >= 16.x がマシンにインストールされています。
• ギットマシンにインストールされています。
• 実行中の TiDB クラスター。

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

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

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

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

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

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

git clone https://github.com/tidb-samples/tidb-nodejs-typeorm-quickstart.git
cd tidb-nodejs-typeorm-quickstart

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

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

npm install

npm install typeorm mysql2 dotenv --save
npm install @types/node ts-node typescript --save-dev

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

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

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

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

次のコマンドを実行して TypeORM CLI を起動し、 src/migrationsフォルダー内の移行ファイルに記述された SQL ステートメントを使用してデータベースを初期化します。

npm run migration:run

query: SELECT VERSION() AS `version`
query: SELECT * FROM `INFORMATION_SCHEMA`.`COLUMNS` WHERE `TABLE_SCHEMA` = 'test' AND `TABLE_NAME` = 'migrations'
query: CREATE TABLE `migrations` (`id` int NOT NULL AUTO_INCREMENT, `timestamp` bigint NOT NULL, `name` varchar(255) NOT NULL, PRIMARY KEY (`id`)) ENGINE=InnoDB
query: SELECT * FROM `test`.`migrations` `migrations` ORDER BY `id` DESC
0 migrations are already loaded in the database.
1 migrations were found in the source code.
1 migrations are new migrations must be executed.
query: START TRANSACTION
query: CREATE TABLE `profiles` (`player_id` int NOT NULL, `biography` text NOT NULL, PRIMARY KEY (`player_id`)) ENGINE=InnoDB
query: CREATE TABLE `players` (`id` int NOT NULL AUTO_INCREMENT, `name` varchar(50) NOT NULL, `coins` decimal NOT NULL, `goods` int NOT NULL, `created_at` datetime NOT NULL, `profilePlayerId` int NULL, UNIQUE INDEX `uk_players_on_name` (`name`), UNIQUE INDEX `REL_b9666644b90ccc5065993425ef` (`profilePlayerId`), PRIMARY KEY (`id`)) ENGINE=InnoDB
query: ALTER TABLE `players` ADD CONSTRAINT `fk_profiles_on_player_id` FOREIGN KEY (`profilePlayerId`) REFERENCES `profiles`(`player_id`) ON DELETE NO ACTION ON UPDATE NO ACTION
query: INSERT INTO `test`.`migrations`(`timestamp`, `name`) VALUES (?, ?) -- PARAMETERS: [1693814724825,"Init1693814724825"]
Migration Init1693814724825 has been  executed successfully.
query: COMMIT

移行ファイルは、 src/entitiesフォルダーで定義されたエンティティから生成されます。TypeORM でエンティティを定義する方法については、 タイプORM: エンティティを参照してください。

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

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

npm start

予想される実行出力:

接続が成功すると、ターミナルは次のように TiDB クラスターのバージョンを出力します。

🔌 Connected to TiDB cluster! (TiDB version: 8.0.11-TiDB-v8.1.2)
🆕 Created a new player with ID 2.
ℹ️ Got Player 2: Player { id: 2, coins: 100, goods: 100 }
🔢 Added 50 coins and 50 goods to player 2, now player 2 has 100 coins and 150 goods.
🚮 Deleted 1 player data.

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

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

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

接続オプションで接続する

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

// src/dataSource.ts

// Load environment variables from .env file to process.env.
require('dotenv').config();

export const AppDataSource = new DataSource({
  type: "mysql",
  host: process.env.TIDB_HOST || '127.0.0.1',
  port: process.env.TIDB_PORT ? Number(process.env.TIDB_PORT) : 4000,
  username: process.env.TIDB_USER || 'root',
  password: process.env.TIDB_PASSWORD || '',
  database: process.env.TIDB_DATABASE || 'test',
  ssl: process.env.TIDB_ENABLE_SSL === 'true' ? {
    minVersion: 'TLSv1.2',
    ca: process.env.TIDB_CA_PATH ? fs.readFileSync(process.env.TIDB_CA_PATH) : undefined
  } : null,
  synchronize: process.env.NODE_ENV === 'development',
  logging: false,
  entities: [Player, Profile],
  migrations: [__dirname + "/migrations/**/*{.ts,.js}"],
});

注記

TiDB Cloud Serverless の場合、パブリックエンドポイントを使用するときは TLS 接続を有効にする必要があります。このサンプルコードでは、 .envファイルの環境変数TIDB_ENABLE_SSL trueに設定してください。

ただし、Node.js はデフォルトで組み込みのMozilla CA 証明書使用し、これはTiDB Cloud Serverless によって信頼されているため、 TIDB_CA_PATHで SSL CA 証明書を指定する必要はありません。

データを挿入

次のクエリは、単一のPlayerレコードを作成し、TiDB によって生成されたidフィールドを含む作成されたPlayerオブジェクトを返します。

const player = new Player('Alice', 100, 100);
await this.dataSource.manager.save(player);

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

クエリデータ

次のクエリは、ID 101 の単一のオブジェクトPlayerを返します。レコードが見つからない場合はnull返します。

const player: Player | null = await this.dataSource.manager.findOneBy(Player, {
  id: id
});

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

データの更新

次のクエリは、ID 101の商品Playerに商品50を追加します。

const player = await this.dataSource.manager.findOneBy(Player, {
  id: 101
});
player.goods += 50;
await this.dataSource.manager.save(player);

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

データを削除する

次のクエリは、ID 101のPlayer削除します。

await this.dataSource.manager.delete(Player, {
  id: 101
});

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

生のSQLクエリを実行する

次のクエリは生のSQL文（ SELECT VERSION() AS tidb_version; ）を実行し、TiDBクラスタのバージョンを返します。

const rows = await dataSource.query('SELECT VERSION() AS tidb_version;');
console.log(rows[0]['tidb_version']);

詳細についてはタイプORM: データソースAPIを参照してください。

役に立つメモ

外部キー制約

外部キー制約 (実験的) を使用すると、データベース側でチェックを追加することで、データの参照整合性保証されます。ただし、大量のデータを扱うシナリオでは、重大なパフォーマンスの問題が発生する可能性があります。

createForeignKeyConstraintsオプション (デフォルト値はtrue ) を使用して、エンティティ間のリレーションシップを構築するときに外部キー制約を作成するかどうかを制御できます。

@Entity()
export class ActionLog {
    @PrimaryColumn()
    id: number

    @ManyToOne((type) => Person, {
        createForeignKeyConstraints: false,
    })
    person: Person
}

詳細については、 TypeORMFAQおよび外部キー制約を参照してください。

次のステップ

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

ヘルプが必要ですか?

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