mysql2 promise模式下执行USE数据库命令失败问题咨询

问题场景 #

希望在应用启动时自动创建并连接数据库，编写了如下代码：

const mysql = require('mysql2/promise');

async function setupDB() {
    const db = await mysql.createConnection({
        host: process.env.DB_HOST,
        user: process.env.DB_USER,
        password: process.env.DB_PASSWORD,
        decimalNumbers: true
    });

    await db.execute('CREATE DATABASE IF NOT EXISTS my_db')
        .catch((err) => console.log(`Database creation failed: ${err}`));
 
    await db.execute(`USE my_db`)
        .catch((err) => console.log(`Using database failed: ${err}`));

    return db;
}

执行时触发报错：

Using database failed: Error: This command is not supported in the prepared statement protocol yet

但使用非promise封装的同类代码可以正常运行，疑问原因是什么？

原因分析 #

mysql2/promise中的execute方法是基于MySQL预处理语句协议实现的，这类协议仅支持可参数化的SQL命令（如增删改查等DML操作）。而USE属于会话级的数据库切换命令，并不在预处理语句协议的支持范围内，因此直接用execute执行会触发报错。

传统回调式的mysql库默认使用普通查询协议，这类协议支持所有MySQL命令，包括USE这类会话操作，所以同类代码能正常运行。

解决方法 #

有两种可行的处理方式：

方式1：创建连接时直接指定数据库 #

在初始化连接的配置中直接添加database字段，跳过USE命令的执行，这是更推荐的方式：

const mysql = require('mysql2/promise');

async function setupDB() {
    // 先创建数据库（如果不存在）
    const tempDb = await mysql.createConnection({
        host: process.env.DB_HOST,
        user: process.env.DB_USER,
        password: process.env.DB_PASSWORD,
        decimalNumbers: true
    });
    await tempDb.execute('CREATE DATABASE IF NOT EXISTS my_db')
        .catch((err) => console.log(`Database creation failed: ${err}`));
    await tempDb.end(); // 关闭临时连接

    // 直接连接到目标数据库
    const db = await mysql.createConnection({
        host: process.env.DB_HOST,
        user: process.env.DB_USER,
        password: process.env.DB_PASSWORD,
        database: 'my_db', // 直接指定目标数据库
        decimalNumbers: true
    });

    return db;
}

方式2：改用query方法执行USE命令 #

如果需要在已建立的连接中切换数据库，将execute替换为query方法即可——query基于普通查询协议，支持所有MySQL命令：

// 替换原代码中的USE执行语句
await db.query(`USE my_db`)
    .catch((err) => console.log(`Using database failed: ${err}`));

内容的提问来源于stack exchange，提问作者Karol Borkowski