使用 mysql.js 连接到 TiDB

TiDB 是一个兼容 MySQL 的数据库。mysql.js 是一个纯 Node.js 代码编写的实现了 MySQL 协议的 JavaScript 客户端。

本文档将展示如何使用 TiDB 和 mysql.js 来构造一个简单的 CRUD 应用程序。

• 配置你的环境。
• 使用 mysql.js 驱动连接到 TiDB 集群。
• 构建并运行你的应用程序。你也可以参考示例代码片段，完成基本的 CRUD 操作。

前置需求

为了能够顺利完成本教程，你需要提前：

• 在你的机器上安装 Node.js 16.x 或以上版本。
• 在你的机器上安装 Git。
• 准备一个 TiDB 集群。

如果你还没有 TiDB 集群，可以按照以下方式创建：

• （推荐方式）参考创建 TiDB 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

在你现有的项目当中，你可以通过以下命令安装 mysql 和 dotenv 依赖包（dotenv 用于从 .env 文件中读取环境变量）：

npm install mysql dotenv --save

第 3 步：配置连接信息

根据不同的 TiDB 部署方式，使用不同的方法连接到 TiDB 集群。

• TiDB Serverless
• TiDB Dedicated
• 本地部署的 TiDB

第 4 步：运行代码并查看结果

运行下述命令，执行示例代码：

npm run start

预期输出结果：

如果连接成功，你的终端将会输出所连接集群的版本信息：

🔌 Connected to TiDB cluster! (TiDB version: 8.0.11-TiDB-v8.1.0)
⏳ 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-mysqljs-quickstart。

连接到 TiDB

下面的代码使用环境变量中定义的连接选项来建立与 TiDB 集群的连接。

// 步骤 1. 导入 'mysql' 和 'dotenv' 依赖包。
import { createConnection } from "mysql";
import dotenv from "dotenv";
import * as fs from "fs";

// 步骤 2. 将连接参数从 .env 文件中读取到 process.env 中。
dotenv.config();

// 步骤 3. 创建与 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 = createConnection(options);

// 步骤 4. 执行 SQL 语句。

// 步骤 5. 关闭连接。
conn.end();

插入数据

下面的代码创建了一条 Player 记录，并返回了该记录的 ID。

conn.query('INSERT INTO players (coins, goods) VALUES (?, ?);', [coins, goods], (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 语句前传递到 SQL 中的值进行转义。

  注意

  mysqljs/mysql 包目前还不支持预处理语句，它只在客户端对值进行转义 (相关 issue: mysqljs/mysql#274)。

  如果你希望使用预处理语句来避免 SQL 注入或提升批量插入/更新的效率，推荐使用 mysql2 包。

• 在不涉及大量复杂 SQL 语句的场景下, 推荐使用 ORM 框架 (例如：Sequelize, TypeORM, 或 Prisma) 来提升你的开发效率.

• 当你在数据表中使用到 BIGINT 和 DECIMAL 类型列时，需要开启 Driver 的 supportBigNumbers: true 选项.

下一步

• 关于 mysql.js 驱动的更多使用方法，可以参考 mysql.js 的 GitHub 仓库。
• 你可以继续阅读开发者文档的其它章节来获取更多 TiDB 应用开发的最佳实践。例如：插入数据，更新数据，删除数据，单表读取，事务，SQL 性能优化等。
• 如果你更倾向于参与课程进行学习，我们也提供了专业的 TiDB 开发者课程支持，并在考试后提供相应的资格认证。