MySQL Node.js 驱动程序技术文档

安装指南

环境要求

在安装之前，请确保已经安装了 Node.js。Node.js 版本要求为 0.6 或更高。

安装步骤

使用 npm 安装 MySQL 驱动程序：

$ npm install mysql

如果需要安装最新版本的 MySQL 驱动程序，可以从 GitHub 安装：

$ npm install mysqljs/mysql

项目使用说明

简介

这是一个用于 MySQL 数据库的 Node.js 驱动程序。它完全使用 JavaScript 编写，无需编译，并且采用 MIT 许可证。

示例代码

以下是一个简单的使用示例：

var mysql = require('mysql');
var connection = mysql.createConnection({
  host: 'localhost',
  user: 'me',
  password: 'secret',
  database: 'my_db'
});

connection.connect();

connection.query('SELECT 1 + 1 AS solution', function (error, results, fields) {
  if (error) throw error;
  console.log('The solution is: ', results[0].solution);
});

connection.end();

关键点

• 每个连接上的方法调用都会按顺序排队并执行。
• 使用 end() 方法关闭连接，确保所有剩余的查询在发送退出包到 MySQL 服务器之前执行完毕。

项目 API 使用文档

建立连接

推荐的方式是显式建立连接：

var mysql = require('mysql');
var connection = mysql.createConnection({
  host: 'example.org',
  user: 'bob',
  password: 'secret'
});

connection.connect(function(err) {
  if (err) {
    console.error('error connecting: ' + err.stack);
    return;
  }

  console.log('connected as id ' + connection.threadId);
});

也可以通过执行查询隐式建立连接：

var mysql = require('mysql');
var connection = mysql.createConnection(...);

connection.query('SELECT 1', function (error, results, fields) {
  if (error) throw error;
  // connected!
});

连接选项

在建立连接时，可以设置以下选项：

• host: 数据库的主机名（默认：localhost）
• port: 连接的端口号（默认：3306）
• localAddress: TCP 连接的源 IP 地址（可选）
• socketPath: 连接的 Unix 域套接字路径（使用时忽略 host 和 port）
• user: MySQL 用户名
• password: MySQL 用户密码
• database: 连接使用的数据库名称（可选）
• charset: 连接的字符集（默认：'UTF8_GENERAL_CI'）
• timezone: MySQL 服务器配置的时区（默认：'local'）
• connectTimeout: 连接超时时间（默认：10000 毫秒）
• stringifyObjects: 将对象字符串化而不是转换为值（默认：false）
• insecureAuth: 允许连接到要求旧（不安全）认证方法的 MySQL 实例（默认：false）
• typeCast: 确定是否应将列值转换为原生 JavaScript 类型（默认：true）
• queryFormat: 自定义查询格式函数（参见 自定义格式）
• supportBigNumbers: 处理数据库中的大数（BIGINT 和 DECIMAL 列）时启用此选项（默认：false）
• bigNumberStrings: 启用 supportBigNumbers 和 bigNumberStrings 时，大数将始终作为 JavaScript String 对象返回（默认：false）
• dateStrings: 强制日期类型（TIMESTAMP, DATETIME, DATE）作为字符串返回（默认：false）
• debug: 将协议详细信息打印到标准输出（默认：false）
• trace: 在 Error 上生成堆栈跟踪（默认：true）
• localInfile: 允许 LOAD DATA INFILE 使用 LOCAL 修饰符（默认：true）
• multipleStatements: 允许每个查询执行多个 MySQL 语句（默认：false）
• flags: 连接标志列表（参见 连接标志）
• ssl: SSL 配置对象

项目安装方式

使用 npm 安装

$ npm install mysql

从 GitHub 安装最新版本

$ npm install mysqljs/mysql