node-mysql-native 项目技术文档

2024-12-16 20:19:59作者：钟日瑜

1. 安装指南

安装环境要求

Node.js 环境
npm 包管理器

安装步骤

打开终端或命令行工具。
运行以下命令安装 mysql-native 模块：
```
npm install mysql-native
```

2. 项目的使用说明

基本使用示例

以下是一个简单的使用示例，展示了如何连接到 MySQL 数据库并执行查询：

var db = require("mysql-native").createTCPClient(); // 默认连接到 localhost:3306
db.auto_prepare = true;

function dump_rows(cmd) {
   cmd.addListener('row', function(r) { console.dir(r); } );
}

db.auth("test", "testuser", "testpass");
dump_rows(db.query("select 1+1,2,3,'4',length('hello')"));
dump_rows(db.execute("select 1+1,2,3,'4',length(?)", ["hello"]));
db.close();

输出结果

row: [ 2, 2, 3, "4", 5]
row: [ 2, 2, 3, "4", 5]

3. 项目API使用文档

模块函数

createClient(socket)：从双向流创建客户端（TODO：添加本地服务器套接字的默认路径）。
createTCPClient(host, port)：创建 TCP 客户端，默认主机为 127.0.0.1，端口为 3306。
createUNIXClient(path)：连接到 Unix 域套接字，默认路径为 /var/run/mysqld/mysqld.sock。

客户端函数

所有命令在执行结束时都会触发 'end'() 事件。

auth(db, user, pass)：执行 MySQL 连接握手。应该是第一个命令（TODO：如果缺少用户/密码，添加默认用户/密码？）。
- 事件：'authorized'(serverStatus)。
query(sql)：简单查询。
- 事件：
  - 'field'(field)：每个字段描述触发一次。
  - 'fields_eof'()：最后一个字段后触发。
  - 'row'(rows)：结果集中的每一行触发一次，传递字段值数组。
client.prepare(sql)：准备一个语句并将结果存储在 client.pscache 中。
- 事件：
  - 'prepared'(preparedStatement)。
  - 'parameter'(field)：输入参数描述。
execute(sql, parameters)：parameters 是一个值数组。已知类型以适当的 MySQL 二进制类型发送（TODO：目前并非如此，类型始终为字符串，并使用 param.toString() 进行转换）。
- 事件：与 query() 相同。
client.close：创建并排队相应的命令。
client.execute：如果 client.auto_prepare 设置为 true 且没有缓存的语句，则添加准备命令（TODO：添加比 client.auto_prepare 标志更好的 API）。
client.terminate：立即关闭连接。