Registry /
database / webiny-mysql-connection
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 createConnection from 'webiny-mysql-connection'
✗ const createConnection = require('webiny-mysql-connection')
Default export only; ESM or CommonJS via default interop.
createConnection
✓ import createConnection from 'webiny-mysql-connection'
✗ import { createConnection } from 'webiny-mysql-connection'
Named import is incorrect; use default import.
Connection
✓ import type { Connection } from 'webiny-mysql-connection'
✗ import { Connection } from 'webiny-mysql-connection'
Type import only; Connection is a TypeScript interface, not a constructor.
Shows creating a connection and executing a simple query with TypeScript types.
import createConnection from 'webiny-mysql-connection';
import type { Connection } from 'webiny-mysql-connection';
async function main() {
const connection: Connection = await createConnection({
host: process.env.MYSQL_HOST ?? 'localhost',
port: Number(process.env.MYSQL_PORT ?? 3306),
user: process.env.MYSQL_USER ?? 'root',
password: process.env.MYSQL_PASSWORD ?? '',
database: process.env.MYSQL_DATABASE ?? 'test'
});
const [rows] = await connection.execute('SELECT 1+1 AS result');
console.log(rows);
await connection.end();
}
main().catch(console.error);
Errors
Common errors & fixes
Cannot find module 'webiny-mysql-connection'
Missing dependency installation
fixRun 'npm install webiny-mysql-connection' or 'yarn add webiny-mysql-connection'
TypeError: createConnection is not a function
Wrong import style (named import instead of default)
fixUse 'import createConnection from 'webiny-mysql-connection';'
Error: Cannot read properties of undefined (reading 'execute')
Connection object not resolved correctly, possibly due to incorrect import or missing await
fixEnsure you await the createConnection call and use default import.
Audit
Dependencies
mysql2requiredprovides MySQL client with prepared statements and promise support