npmpackage.info

Gathering detailed insights and metrics for sql-template-tag

Other packages similar to sql-template-tag

@flowblade/sql-tag

0.1.15

Raw sql template literal

@wzrdtales/sql-template-tag

5.0.6

ES2015 tagged template string for preparing SQL statements, works with `pg` and `mysql`

eslint-plugin-sql-template

3.1.0

ESLint plugin with rules for using the `sql` template tag on raw SQL queries

sql-tag

1.0.1

A template tag for writing elegant sql strings

Gathering detailed insights and metrics for sql-template-tag

sql-template-tag - 5.2.1 | npmpackage.info

sql-template-tag

ES2015 tagged template string for preparing SQL statements, works with `pg`, `mysql`, `sqlite` and `oracledb`

5.2.1

379

MIT

TypeScript

20.35 kB

3,039,329 3.3

Installations

npm install sql-template-tag

Developer Guide

BETA

Typescript

No

Module System

ESM

Min. Node Version

>=14

Node Version

20.12.1

NPM Version

10.5.0 Pull Requests

Open

3

Total

25

Closed

3

Merged

19

Issues

Open

2

Total

23

Closed

21

Releases

Documentation: Native OracleDB support

v5.2.1

Updated on Apr 20, 2024

OracleDB support

v5.2.0

Updated on Nov 28, 2023

Bulk method and readonly input types

v5.1.0

Updated on Sep 04, 2023

Set `Value` type to `unknown`

v5.0.3

Updated on May 27, 2022

Performance improvements

v5.0.2

Updated on May 13, 2022

Allow `Date` as value type

v5.0.1

Updated on Jan 31, 2022

View All 16 releases

Languages

TypeScript

TypeScript (100%)

Developer

blakeembrey

Download Statistics

Total Downloads

3,039,329

Last Day

262

Last Week

29,697

Last Month

133,688

Last Year

1,369,282

GitHub Statistics

MIT License

379 Stars

88 Commits

18 Forks

3 Watchers

4 Branches

7 Contributors

Updated on Jun 06, 2025

Maintainers

View All 7 Contributors

Package Meta Information

Latest Version

5.2.1

Package Id

sql-template-tag@5.2.1

Unpacked Size

20.35 kB

Size

5.85 kB

File Count

NPM Version

10.5.0

Node Version

20.12.1

Published on

Apr 20, 2024

Total Downloads

Cumulative downloads

Total Downloads

3,039,329

Last Day

0.4%

262

Compared to previous day

Last Week

-4.5%

29,697

Compared to previous week

Last Month

-6.4%

133,688

Compared to previous month

Last Year

94.1%

1,369,282

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

@borderless/ts-scripts @types/bytes @types/node @vitest/coverage-v8 bytes rimraf tsx typescript vitest

SQL Template Tag

ES2015 tagged template string for preparing SQL statements.

Installation

npm install sql-template-tag --save

Usage

1import sql, { empty, join, raw } from "sql-template-tag";
2
3const query = sql`SELECT * FROM books WHERE id = ${id}`;
4
5query.sql; //=> "SELECT * FROM books WHERE id = ?"
6query.text; //=> "SELECT * FROM books WHERE id = $1"
7query.statement; //=> "SELECT * FROM books WHERE id = :1"
8query.values; //=> [id]
9
10pg.query(query); // Uses `text` and `values`.
11mysql.query(query); // Uses `sql` and `values`.
12oracledb.execute(query); // Uses `statement` and `values`.
13
14// Embed SQL instances inside SQL instances.
15const nested = sql`SELECT id FROM authors WHERE name = ${"Blake"}`;
16const query = sql`SELECT * FROM books WHERE author_id IN (${nested})`;
17
18// Join and "empty" helpers (useful for nested queries).
19sql`SELECT * FROM books ${hasIds ? sql`WHERE ids IN (${join(ids)})` : empty}`;

Join

Accepts an array of values or SQL, and returns SQL with the values joined together using the separator.

1const query = join([1, 2, 3]);
2
3query.sql; //=> "?,?,?"
4query.values; //=> [1, 2, 3]

Tip: You can set the second argument to change the join separator, for example:

1join(
2  [sql`first_name LIKE ${firstName}`, sql`last_name LIKE ${lastName}`],
3  " AND ",
4); // => "first_name LIKE ? AND last_name LIKE ?"

Raw

Accepts a string and returns a SQL instance, useful if you want some part of the SQL to be dynamic.

1raw("SELECT"); // == sql`SELECT`

Do not accept user input to raw, this will create a SQL injection vulnerability.

Empty

Simple placeholder value for an empty SQL string. Equivalent to raw("").

Bulk

Accepts an array of arrays, and returns the SQL with the values joined together in a format useful for bulk inserts.

1const query = sql`INSERT INTO users (name) VALUES ${bulk([
2  ["Blake"],
3  ["Bob"],
4  ["Joe"],
5])}`;
6
7query.sql; //=> "INSERT INTO users (name) VALUES (?),(?),(?)"
8query.values; //=> ["Blake", "Bob", "Joe"]

Recipes

This package "just works" with pg, mysql, sqlite and oracledb.

MSSQL

1mssql.query(query.strings, ...query.values);

Stricter TypeScript

The default value is unknown to support every possible input. If you want stricter TypeScript values you can create a new sql template tag function.

1import { Sql } from "sql-template-tag";
2
3type SupportedValue =
4  | string
5  | number
6  | SupportedValue[]
7  | { [key: string]: SupportedValue };
8
9function sql(
10  strings: ReadonlyArray<string>,
11  ...values: Array<SupportedValue | Sql>
12) {
13  return new Sql(strings, values);
14}

Some other modules exist that do something similar:

sql-template-strings: promotes mutation via chained methods and lacks nesting SQL statements. The idea to support sql and text properties for dual mysql and pg compatibility came from here.
pg-template-tag: missing TypeScript and MySQL support. This is the API I envisioned before writing this library, and by supporting pg only it has the ability to dedupe values.

License

MIT

No vulnerabilities found.

10

Security-Policy

Determines if the project has published a security policy.

10

Dangerous-Workflow

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

10

Binary-Artifacts

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

10

License

Determines if the project has defined a license.

2

Pinned-Dependencies

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

1

Code-Review

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

0

Token-Permissions

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

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

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

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

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

3.3

/10

Last Scanned on 2025-06-30

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

Other packages similar to sql-template-tag

Other packages similar to sql-template-tag

sql-template-tag

Installations

Developer Guide

No

ESM

>=14

20.12.1

10.5.0

Pull Requests

3

25

3

19

Issues

2

23

21

Releases

Languages

Developer

blakeembrey

Download Statistics

GitHub Statistics

Maintainers

Package Meta Information

Total Downloads

3,039,329

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

SQL Template Tag

Installation

Usage

Join

Raw

Empty

Bulk

Recipes

MSSQL

Stricter TypeScript

Related

License

10

10

10

10

2

1

0

0

0

0

0

0

0

3.3

/10