npm.io
0.2.1 โ€ข Published 1 month ago

@sqltags/mysql

Licence
MIT
Version
0.2.1
Deps
2
Size
8 kB
Vulns
0
Weekly
0
Stars
4

sqltags project logo

Build status npm version


SqlTags MySQL driver

This is the MySQL driver for the @sqltags/core library.

Please refer to the @sqltags/core project README for more information.


What is SqlTags?

Safely create & execute parameterized SQL queries using template strings.

const [user] = await sql`SELECT * FROM users WHERE id = ${userId}`;

Results in the following query:

SELECT * FROM users WHERE id = $1
-- with parameters: [123]

Installation & Usage

Install:

npm install mysql2 @sqltags/mysql

Create a MySQL connection, then create a MySQL tag using the connection:

import mysql from 'mysql2';
import { createMySqlTag } from '@sqltags/mysql';

const connection = mysql.createConnection({ /* ... */ });
const sql = createMySqlTag(connection);

Query:

const [user] = await sql`SELECT * FROM users WHERE id = ${userId}`;

Don't forget to disconnect your client when finished!

await connection.end();