Functional wrapper for sql-template-strings module. The goal of this library is to expose a pipe friendly API.
Install
$ npm i sql-template-strings sql-template-strings-tsDocumentation
t
declare const t: (strings: TemplateStringsArray, ...values: unknown[]) => SQLStatementThe template string tag.
Example:
import * as SQL from 'sql-template-strings-ts'
import { pipe } from 'fp-ts/function'
declare const book: string
declare const author: string
const query = SQL.t`
SELECT author FROM books
WHERE name = ${book} AND author = ${author}`
append
declare const append: (statement: SQLStatement | string | number) => (sql: SQLStatement) => SQLStatementAppends a string or another statement.
Example:
import * as SQL from 'sql-template-strings-ts'
import { identity, pipe } from 'fp-ts/function'
declare const name: string | undefined
declare const offset: number
const query = pipe(
SQL.t`SELECT * FROM books`,
name ? SQL.append(SQL.t` WHERE name = ${name}`) : identity,
SQL.append(SQL.t` LIMIT 10 OFFSET ${offset}`),
)
setName
declare const setName: (name: string) => (sql: SQLStatement) => SQLStatementSets the name property of this statement for prepared statements in PostgreSQL.
useBind
declare const useBind: (bind: boolean) => (sql: SQLStatement) => SQLStatementUse a prepared statement with Sequelize. Makes query return a query with $n syntax instead of ? and switches the values key name to bind.
Please refer to sql-template-strings documentation for further details.