npmpackage.info

Gathering detailed insights and metrics for mysql-query-placeholders

mysql-query-placeholders - 0.2.2 | npmpackage.info

mysql-query-placeholders

Query builder for prepared statements.

0.2.2

TypeScript

8.91 kB

2.4

Installations

npm install mysql-query-placeholders

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

12.19.0

NPM Version

6.14.8 Pull Requests

Open

0

Total

17

Closed

0

Merged

17

Issues

Open

0

Total

2

Closed

2

Releases

v0.2.2

Updated on Oct 23, 2020

v0.2.0

Updated on Oct 15, 2020

v0.1.1

Updated on Oct 14, 2020

v0.1.0

Updated on Oct 14, 2020

View All 4 releases

Languages

TypeScript

JavaScript

TypeScript (98.82%)

JavaScript (1.18%)

Developer

ricardo-dlc

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

1 Stars

11 Commits

1 Watchers

2 Branches

1 Contributors

Updated on Dec 04, 2020

Maintainers

View All 1 Contributors

Package Meta Information

Latest Version

0.2.2

Package Id

mysql-query-placeholders@0.2.2

Unpacked Size

8.91 kB

Size

3.20 kB

File Count

NPM Version

6.14.8

Node Version

12.19.0

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

@commitlint/cli @commitlint/config-conventional @types/chai @types/mocha @types/node chai gts husky mocha ts-node ts-node-dev typescript

mysql-query-placeholders

Build prepared statements from named parameters.

Consider the following object:

1const user = {
2  id: 123,
3  status: {
4    active: true,
5  },
6  services: {
7    home: {
8      route: '/',
9    },
10    dashboard: {
11      route: '/dashboard',
12    },
13  },
14  name: 'John',
15  email: 'email@mail.com',
16};

Then you can easily create a prepared statement for MySQL using the data from the object above.

1const mqp = require('mysql-query-placeholders');
2const mysql = require('mysql2').createConnection...
3
4const query = 'SELECT * FROM users WHERE id = :id AND name = :name;';
5const queryData = mqp.queryBuilder(query, user);
6console.log(queryData);
7// {
8//   sql: 'SELECT * FROM users WHERE id = ? AND name = ?;',
9//   values: [123, 'John'],
10// }
11
12// use named parameters
13mysql.query(queryData, (err, result) => {...});

ES6 Module

1import {queryBuilder} from 'mysql-query-placeholders';
2import {createConnection} from 'mysql2/promise';
3
4const mysql = createConnection(...);
5
6const query = 'SELECT * FROM users WHERE id = :id AND name = :name;';
7const queryData = queryBuilder(query, user);
8console.log(queryData);
9// {
10//   sql: 'SELECT * FROM users WHERE id = ? AND name = ?;',
11//   values: [123, 'John'],
12// }
13
14// use named parameters
15await mysql.query(queryData);

Handling missing parameters

MySQL throws an error if a parameter is not given. Passing a configuration object with useNullForMissing set to true (which is true by default), a null value is used instead.

1const query = 'SELECT * FROM users WHERE id = :id AND last_name = :last_name;';
2const queryData = mqp.queryBuilder(query, user, {useNullForMissing: true});
3console.log(queryData);
4// {
5//   sql: 'SELECT * FROM users WHERE id = ? AND last_name = ?;',
6//   values: [123, null],
7// }

If you do not want to use null by default, you can throw an error instead, setting the useNullForMissing configuration option to false.

1try {
2  const query = 'SELECT * FROM users WHERE id = :id AND last_name = :last_name;';
3  const queryData = mqp.queryBuilder(query, user, {useNullForMissing: false});
4} catch (e) {
5  errorMessage = e.message;
6  console.log(errorMessage);
7  // Missing value for statement.
8  //   last_name not provided for statement:
9  //   ...
10}

Support for multiple level object property values

mqp is capable to get a object property value from a key.name.property.value syntax. This is useful when you do not want to reassign the property value to another variable or you want to use the original object instead of creating a new one.

1const query = 'SELECT * FROM services WHERE route IN (:services.dashboard.route, :services.home.route);';
2const queryData = mqp.queryBuilder(query, user);
3console.log(queryData);
4// {
5//   sql: 'SELECT * FROM services WHERE route IN (?, ?);',
6//   values: [ '/dashboard', '/' ]
7// }

Missing property:

1const query = 'INSERT INTO services (name, route) VALUES (\'cpanel\', :services.cpanel.route);';
2const queryData = mqp.queryBuilder(query, user);
3console.log(queryData);
4// {
5//   sql: "INSERT INTO services (name, route) VALUES ('cpanel', ?);",
6//   values: [ null ]
7// }

Or using {useNullForMissing: false} config:

1try {
2  const query = 'SELECT * FROM services WHERE route = :services.cpanel.route;';
3  const queryData = mqp.queryBuilder(query, user, {useNullForMissing: false});
4} catch (e) {
5  errorMessage = e.message;
6  console.log(errorMessage);
7  //  Missing value for statement.
8  //    services.cpanel.route not provided for statement:
9  //    ...
10}

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

3

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

License

Determines if the project has defined a license.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

2.4

/10

Last Scanned on 2025-07-07

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More