qiao-mysql

library6.0.0jsnpmunverified

A lightweight Node.js MySQL client plugin providing a simplified interface for database operations. Version 6.0.0 offers connection pooling, query building, and promise-based async/await support. Maintained as part of the qiao-z ecosystem, it focuses on minimal configuration and ease of use compared to more complex ORMs or full-featured drivers like mysql2 or knex. Release cadence is irregular with occasional major version bumps.

database

npm install qiao-mysql

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · QIAO-MYSQL

qiao-mysql

databasejavascriptv6.0.0

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

default

✓ import mysql from 'qiao-mysql'

✗ const mysql = require('qiao-mysql')

ESM-only since v6; commonjs require is not supported.

query

✓ import { query } from 'qiao-mysql'

✗ const { query } = require('qiao-mysql')

Named export for executing raw SQL. Use with ESM imports.

getPool

✓ import { getPool } from 'qiao-mysql'

✗ const getPool = require('qiao-mysql').getPool

Returns a mysql2 connection pool. Preferred for production.

Shows how to create a connection pool and execute a parameterized query using async/await.

import mysql from 'qiao-mysql'; async function main() { const config = { host: process.env.DB_HOST ?? 'localhost', user: process.env.DB_USER ?? 'root', password: process.env.DB_PASS ?? '', database: process.env.DB_NAME ?? 'test' }; // Get a pool const pool = mysql.getPool(config); // Execute a query const [rows, fields] = await pool.query('SELECT ? + ? AS sum', [1, 2]); console.log('Sum:', rows[0].sum); // Close pool await pool.end(); } main().catch(console.error);

Debug

Known issues

breakingVersion 6.0.0 drops CommonJS support; only ESM imports work.

fix

Convert require() calls to import statements. Use dynamic import() if needed.

affects: >=6.0.0

breakingVersion 5.x removed support for callback-based API. All methods return promises.

fix

Migrate callbacks to async/await or .then() chains.

affects: >=5.0.0 <6.0.0

deprecatedThe `mysql` default export will be removed in v7. Use named exports instead.

fix

Replace `import mysql from 'qiao-mysql'` with `import { getPool, query } from 'qiao-mysql'`.

affects: >=6.0.0

gotchaPool configurations are shallow merged; nested objects may cause unexpected behavior.

fix

Always provide complete config objects. Avoid mixing pool options.

affects: >=4.0.0

gotchaQuery results are returned as plain arrays when using default export; named export pool.query returns mysql2 result format.

fix

Access data via destructuring: const [rows] = await pool.query(sql);

affects: >=3.0.0

Errors

Common errors & fixes

Error: Cannot find module 'qiao-mysql'

Package not installed or import path incorrect in CommonJS

fix

Run `npm install qiao-mysql` and use ESM import: `import mysql from 'qiao-mysql'`

TypeError: (0 , qiao_mysql.default) is not a function

Using default import in TypeScript without allowSyntheticDefaultImports

fix

Add `"allowSyntheticDefaultImports": true` to tsconfig.json or use named import: `import * as mysql from 'qiao-mysql'`

ER_NOT_SUPPORTED_AUTH_MODE: Client does not support authentication protocol requested by server

MySQL 8 default auth plugin caching_sha2_password not supported by older mysql2

fix

Upgrade mysql2 to latest version. In Node.js 8+ use: `ALTER USER 'user'@'host' IDENTIFIED WITH mysql_native_password BY 'password';`

Upgrade

Version history

6.0.0latest on npm

Audit

Dependencies

mysql2requiredUnderlying MySQL driver for connection and query execution

Agent activity

9 hits · last 30 days

node

Resources

githubhttps://github.com/uikoo9/qiao-z ↗

packageqiao-mysql ↗

homepagehttps://code.vincentqiao.com/#qiao-mysql ↗