📣
TiDB Cloud Premium はパブリックプレビュー中です。エンタープライズワークロード向けの無制限のスケーリング、即時の弾力性、高度なセキュリティを提供します。このページは自動翻訳されたものです。原文はこちらからご覧ください。
AI
開発者向け
ベストプラクティス
API

node-mysql2を使用してTiDBに接続する

TiDBはMySQL互換のデータベースであり、 node-mysql2はNode.js用の高速なmysqljs/mysql互換MySQLドライバです。

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

  • 環境をセットアップしてください。
  • node-mysql2を使用してTiDBに接続します。
  • アプリケーションをビルドして実行します。オプションで、基本的な CRUD 操作用のサンプルコードスニペットを見つけることができます。

注記：

このチュートリアルは、 TiDB Cloud Starter、 TiDB Cloud Essential、 TiDB Cloud Premium、 TiDB Cloud Dedicated、およびTiDB Self-Managedに対応しています。

前提条件

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

  • お使いのコンピューターにNode.js >= 16.xがインストールされていること。
  • お使いのマシンにGitがインストールされています。
  • TiDBクラスタが稼働中です。

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

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

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

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

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

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

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

サンプルアプリに必要なパッケージ（ mysql2およびdotenvを含む）をインストールするには、次のコマンドを実行します。

npm install
既存のプロジェクトに依存関係をインストールします

既存のプロジェクトの場合、以下のコマンドを実行してパッケージをインストールしてください。

npm install mysql2 dotenv --save

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

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

    1. 私のTiDBページに移動し、対象のTiDB Cloud StarterまたはEssentialインスタンスの名前をクリックして、概要ページに移動します。

    2. 右上隅の「接続」をクリックしてください。接続ダイアログが表示されます。

    3. 接続ダイアログの設定がご使用のオペレーティング環境と一致していることを確認してください。

      • 接続タイプはPublicに設定されています。
      • ブランチはmainに設定されています。
      • 「接続」はGeneralに設定されています。
      • オペレーティングシステムは、アプリケーションを実行するオペレーティングシステムと一致します。

    4. まだパスワードを設定していない場合は、 「パスワードを生成」をクリックしてランダムなパスワードを生成してください。

    5. .env.exampleをコピーして.envに名前を変更するには、次のコマンドを実行します。

      cp .env.example .env

    6. .envファイルを編集し、環境変数を以下のように設定し、接続ダイアログ上の対応するプレースホルダー{}接続パラメータに置き換えます。

      TIDB_HOST={host}
TIDB_PORT=4000
TIDB_USER={user}
TIDB_PASSWORD={password}
TIDB_DATABASE=test
TIDB_ENABLE_SSL=true

      注記

      TiDB Cloud Starterの場合、パブリックエンドポイントを使用する際には、 TIDB_ENABLE_SSLを介して TLS 接続を有効にする必要があります。

    7. .envファイルを保存します。

    1. 私のTiDBページに移動し、対象のTiDB Cloud Premiumインスタンスの名前をクリックして概要ページに移動します。

    2. 左側のナビゲーションペインで、 [設定] > [ネットワーク]をクリックします。

    3. ネットワークのページで、 [パブリックエンドポイント**を有効にする]をクリックし、次に[IP アドレスの追加]**をクリックします。

      クライアントのIPアドレスがアクセスリストに追加されていることを確認してください。

    4. 左側のナビゲーションペインで「概要」をクリックすると、インスタンスの概要ページに戻ります。

    5. 右上隅の「接続」をクリックしてください。接続ダイアログが表示されます。

    6. 接続ダイアログで、 「接続タイプ」ドロップダウンリストから「パブリック」を選択します。

      • 公開エンドポイントがまだ有効化中であることを示すメッセージが表示された場合は、処理が完了するまでお待ちください。
      • まだパスワードを設定していない場合は、ダイアログの「ルートパスワードを設定」をクリックしてください。
      • サーバー証明書を確認する必要がある場合、または接続に失敗して認証局（CA）証明書が必要な場合は、 「CA証明書」をクリックしてダウンロードしてください。
      • パブリック接続タイプに加えて、 TiDB Cloud Premium はプライベート エンドポイント接続をサポートします。詳細については、 AWS PrivateLink経由でTiDB Cloud Premiumに接続します。を参照してください。

    7. .env.exampleをコピーして.envに名前を変更するには、次のコマンドを実行します。

      cp .env.example .env

    8. .envファイルを編集し、環境変数を以下のように設定し、接続ダイアログで対応するプレースホルダー{}を接続パラメータに置き換えます。

      TIDB_HOST={host}
TIDB_PORT=4000
TIDB_USER={user}
TIDB_PASSWORD={password}
TIDB_DATABASE=test
TIDB_ENABLE_SSL=false

    9. .envファイルを保存します。

    1. 私のTiDBページに移動し、対象のTiDB Cloud Dedicatedクラスタの名前をクリックして概要ページに移動します。

    2. 右上隅の「接続」をクリックしてください。接続ダイアログが表示されます。

    3. 接続ダイアログで、「接続タイプ」ドロップダウンリストから「パブリック」を選択し、 「CA証明書」をクリックしてCA証明書をダウンロードします。

      IP アクセス リストを設定していない場合は、最初の接続の前に、 [IP アクセス リストの設定] をクリックするか、「IP アクセス リストを設定する」の手順に従ってIPアクセスリストを設定する。

      TiDB Cloud Dedicated は、パブリック接続タイプに加えて、プライベート エンドポイントおよびVPC ピアリング接続タイプもサポートしています。詳細については、 TiDB Cloud Dedicatedクラスタに接続します参照してください。

    4. .env.exampleをコピーして.envに名前を変更するには、次のコマンドを実行します。

      cp .env.example .env

    5. .envファイルを編集し、環境変数を以下のように設定し、接続ダイアログ上の対応するプレースホルダー{}接続パラメータに置き換えます。

      TIDB_HOST={host}
TIDB_PORT=4000
TIDB_USER={user}
TIDB_PASSWORD={password}
TIDB_DATABASE=test
TIDB_ENABLE_SSL=true
TIDB_CA_PATH={downloaded_ssl_ca_path}

      注記

      TiDB Cloud Dedicatedへの接続にパブリックエンドポイントを使用する場合は、TLS接続を有効にすることをお勧めします。

      TLS接続を有効にするには、 TIDB_ENABLE_SSLをtrueに変更し、 TIDB_CA_PATHを使用して、接続ダイアログからダウンロードしたCA証明書のファイルパスを指定します。

    6. .envファイルを保存します。

    1. .env.exampleをコピーして.envに名前を変更するには、次のコマンドを実行します。

      cp .env.example .env

    2. .envファイルを編集し、環境変数を以下のように設定し、接続ダイアログ上の対応するプレースホルダー{}接続パラメータに置き換えます。

      TIDB_HOST={host}
TIDB_PORT=4000
TIDB_USER=root
TIDB_PASSWORD={password}
TIDB_DATABASE=test

      TiDBをローカルで実行している場合、デフォルトのホストアドレスは127.0.0.1で、パスワードは空です。

    3. .envファイルを保存します。

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

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

    npm start

    接続が成功すると、コンソールには次のようにTiDBのバージョンが出力されます。

    🔌 Connected to TiDB cluster! (TiDB version: 8.0.11-TiDB-v8.5.4)
⏳ Loading sample game data...
✅ Loaded sample game data.

🆕 Created a new player with ID 12.
ℹ️ Got Player 12: Player { id: 12, coins: 100, goods: 100 }
🔢 Added 50 coins and 50 goods to player 12, updated 1 row.
🚮 Deleted 1 player data.

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

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

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

    接続オプションを使用して接続します

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

    // Step 1. Import the 'mysql' and 'dotenv' packages.
import { createConnection } from "mysql2/promise";
import dotenv from "dotenv";
import * as fs from "fs";

// Step 2. Load environment variables from .env file to process.env.
dotenv.config();

async function main() {
   // Step 3. Create a connection to TiDB.
   const options = {
      host: process.env.TIDB_HOST || '127.0.0.1',
      port: process.env.TIDB_PORT || 4000,
      user: 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,
   }
   const conn = await createConnection(options);

   // Step 4. Perform some SQL operations...

   // Step 5. Close the connection.
   await conn.end();
}

void main();

    注記

    TiDB Cloud StarterおよびTiDB Cloud Essentialでは、パブリック エンドポイントを使用する場合、 TIDB_ENABLE_SSLを介して TLS 接続を有効にする必要があり**ます**。ただし、Node.js はデフォルトで組み込みの Mozilla CA を使用するため、 TIDB_CA_PATHを介して SSL CA 証明書を指定する必要はありません。この組み込みのMozilla CA証明書はTiDB Cloud Starterによって信頼されています。

    データを挿入する

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

    const [rsh] = await conn.query('INSERT INTO players (coins, goods) VALUES (?, ?);', [100, 100]);
console.log(rsh.insertId);

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

    クエリデータ

    次のクエリは、ID Player 1 } レコードを返します。

    const [rows] = await conn.query('SELECT id, coins, goods FROM players WHERE id = ?;', [1]);
console.log(rows[0]);

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

    データの更新

    以下のクエリは、 50の ID を持つ50にPlayerコインと1の商品を追加します。

    const [rsh] = await conn.query(
    'UPDATE players SET coins = coins + ?, goods = goods + ? WHERE id = ?;',
    [50, 50, 1]
);
console.log(rsh.affectedRows);

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

    データを削除する

    以下のクエリは、IDがPlayerである1レコードを削除します。

    const [rsh] = await conn.query('DELETE FROM players WHERE id = ?;', [1]);
console.log(rsh.affectedRows);

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

    役立つメモ

    • 接続プールを使用してデータベース接続を管理することで、接続の頻繁な確立と切断によって発生するパフォーマンスのオーバーヘッドを削減できます。
    • SQL インジェクションを回避するには、 準備された声明を使用することをお勧めします。
    • 複雑な SQL ステートメントがあまり含まれないシナリオでは、シークエライズ、 TypeORM 、またはプリズマなどの ORM フレームワークを使用すると、開発効率が大幅に向上します。
    • データベースで大きな数値（ supportBigNumbers: true列とBIGINT列）を扱う場合は、 DECIMALオプションを有効にすることをお勧めします。
    • ネットワークの問題によるソケットエラーenableKeepAlive: true回避するために、{ read ECONNRESETオプションを有効にすることをお勧めします。（関連する問題： sidorares/node-mysql2#683 ）

    次のステップ

    お困りですか？

    このページは役に立ちましたか？