Registry / database / query-builder-mysql

query-builder-mysql

library3.3.0jsnpmunverified

A TypeScript-based query builder for MySQL and MariaDB, version 3.3.0. It provides a fluent API for constructing SQL queries with type safety. The package is actively maintained with periodic updates. Key differentiators include full TypeScript support with type inference for query results and compatibility with the mariadb driver. It supports SELECT, INSERT, UPDATE, DELETE, JOINs, subqueries, and raw expressions. Ideal for projects using MySQL or MariaDB in a Node.js TypeScript environment.

database

npm install query-builder-mysql

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · QUERY-BUILDER-MYSQ

query-builder-mysql

databasejavascriptv3.3.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.

QueryBuilder

✓ import { QueryBuilder } from 'query-builder-mysql'

✗ import QueryBuilder from 'query-builder-mysql'

Default export is not available; always use named import.

QueryBuilder

✓ const { QueryBuilder } = require('query-builder-mysql')

✗ const QueryBuilder = require('query-builder-mysql')

In CommonJS, destructure the named export.

Creates a QueryBuilder instance, builds a SELECT query with a WHERE clause and ORDER BY, then outputs the SQL string.

import { QueryBuilder } from 'query-builder-mysql'; const qb = new QueryBuilder(); const query = qb .select('*') .from('users') .where('age', '>', 18) .orderBy('name', 'ASC') .build(); console.log(query); // Output: SELECT * FROM users WHERE age > 18 ORDER BY name ASC

Debug

Known issues

gotchaThe build() method must be called to get the final SQL string.

fix

Always call .build() at the end of the query chain.

affects: >=1.0.0

gotchaTable and column names are not escaped by default; may expose SQL injection if user input is passed directly.

fix

Use parameterized values via .where() or .set() methods instead of string concatenation.

affects: >=1.0.0

gotchaThe package requires mariadb as a peer dependency; not having it installed will cause runtime errors.

fix

Install mariadb: npm install mariadb

affects: >=3.0.0

Errors

Common errors & fixes

Cannot find module 'query-builder-mysql'

Package not installed or import path incorrect.

fix

Run 'npm install query-builder-mysql' and ensure import statement is correct.

TypeError: qb.select is not a function

Using default import instead of named import.

fix

Use 'import { QueryBuilder } from 'query-builder-mysql' instead of default import.

Error: Cannot find module 'mariadb'

Missing peer dependency mariadb.

fix

Install mariadb: npm install mariadb

Upgrade

Version history

3.3.0latest on npm

Audit

Dependencies

mariadbrequiredPeer dependency for database connection

Agent activity

10 hits · last 30 days

node