mysql.js で TiDB に接続する

TiDB は MySQL 互換のデータベースであり、 js のドライバーは MySQL プロトコルを実装する純粋な Node.js JavaScript クライアントです。

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

環境を設定します。
mysql.js ドライバーを使用して 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-mysqljs-quickstart.git
cd tidb-nodejs-mysqljs-quickstart

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

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

npm install

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

既存のプロジェクトの場合は、次のコマンドを実行してパッケージをインストールします。

npm install mysql dotenv --save

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

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

クラスターページに移動し、ターゲットクラスターの名前をクリックして概要ページに移動します。
右上隅の「接続」をクリックします。接続ダイアログが表示されます。
接続ダイアログの構成が動作環境と一致していることを確認します。
- 接続タイプはPublicに設定されています。
- ブランチはmainに設定されています。
- Connect With はGeneralに設定されています。
- オペレーティングシステムは、アプリケーションを実行するオペレーティングシステムと一致します。
まだパスワードを設定していない場合は、 「パスワードの生成」をクリックしてランダムなパスワードを生成します。
次のコマンドを実行して.env.exampleコピーし、名前を.envに変更します。
```
cp .env.example .env
```
.envファイルを編集し、環境変数を次のように設定し、接続ダイアログで対応するプレースホルダー{}を接続パラメータに置き換えます。
```
TIDB_HOST={host}
TIDB_PORT=4000
TIDB_USER={user}
TIDB_PASSWORD={password}
TIDB_DATABASE=test
TIDB_ENABLE_SSL=true
```
注記
TiDB Cloud Serverless の場合、パブリックエンドポイントを使用する場合は、 TIDB_ENABLE_SSL経由で TLS 接続を有効にする必要があります。
.envファイルを保存します。

クラスターページに移動し、ターゲットクラスターの名前をクリックして概要ページに移動します。
右上隅の「接続」をクリックします。接続ダイアログが表示されます。
接続ダイアログで、 [接続タイプ]ドロップダウンリストから[パブリック]を選択し、 [CA 証明書]をクリックして CA 証明書をダウンロードします。
IP アクセスリストを設定していない場合は、 「IP アクセスリストの設定」をクリックするか、手順IPアクセスリストを構成するに従って最初の接続の前に設定してください。
TiDB Dedicated は、パブリック接続タイプに加えて、プライベートエンドポイントとVPC ピアリング接続タイプもサポートしています。詳細については、 TiDB専用クラスタに接続するを参照してください。
次のコマンドを実行して.env.exampleコピーし、名前を.envに変更します。
```
cp .env.example .env
```
.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 証明書のファイルパスを指定します。
.envファイルを保存します。

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

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

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

npm start

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

🔌 Connected to TiDB cluster! (TiDB version: 8.0.11-TiDB-v7.5.3)
⏳ 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-サンプル/tidb-nodejs-mysqljs-クイックスタートリポジトリを参照してください。

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

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

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

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

// Step 3. Create a connection to the TiDB cluster.
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 = createConnection(options);

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

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

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

データを挿入

次のクエリは、1 つPlayerレコードを作成し、新しく作成されたレコードの ID を返します。

conn.query('INSERT INTO players (coins, goods) VALUES (?, ?);', [100, 100], (err, ok) => {
   if (err) {
       console.error(err);
   } else {
       console.log(ok.insertId);
   }
});

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

クエリデータ

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

conn.query('SELECT id, coins, goods FROM players WHERE id = ?;', [1], (err, rows) => {
   if (err) {
      console.error(err);
   } else {
      console.log(rows[0]);
   }
});

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

データの更新

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

conn.query(
   'UPDATE players SET coins = coins + ?, goods = goods + ? WHERE id = ?;',
   [50, 50, 1],
   (err, ok) => {
      if (err) {
         console.error(err);
      } else {
          console.log(ok.affectedRows);
      }
   }
);

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

データを削除する

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

conn.query('DELETE FROM players WHERE id = ?;', [1], (err, ok) => {
    if (err) {
        reject(err);
    } else {
        resolve(ok.affectedRows);
    }
});

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

役に立つメモ

接続プールを使用してデータベース接続を管理すると、接続の確立と破棄を頻繁に行うことによって発生するパフォーマンスのオーバーヘッドを削減できます。
SQL インジェクション攻撃を回避するには、SQL を実行する前にクエリ値のエスケープ使用することをお勧めします。
注記
mysqljs/mysqlパッケージはまだ準備されたステートメントをサポートしておらず、クライアント側で値をエスケープするだけです (関連する問題: mysqljs/mysql#274 )。
この機能を使用して SQL インジェクションを回避したり、バッチ挿入/更新の効率を向上させたい場合は、代わりにマイSQL2パッケージを使用することをお勧めします。
ORM フレームワークを使用して、続編、タイプORM 、プリズマなどの複雑な SQL ステートメントを多数使用しないシナリオで開発効率を向上させます。
データベース内の大きな数値 ( BIGINTとDECIMAL列) を処理する場合は、 supportBigNumbers: trueオプションを有効にすることをお勧めします。

次のステップ

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

ヘルプが必要ですか?

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