# sql-templater

> Simple SQL templates.

Latest version **1.0.0** (published 2015-08-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install sql-templater
pnpm add sql-templater
yarn add sql-templater
bun add sql-templater
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2015-08-12 |
| First published | 2015-08-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Anton Sever |
| Maintainers | sever |
| Keywords | sql, template |

## Links

- npm: https://www.npmjs.com/package/sql-templater
- Repository: https://github.com/AntonSever/sql-templater
- Issues: https://github.com/AntonSever/sql-templater/issues
- npm.io page: https://npm.io/package/sql-templater

## Recent versions

- 1.0.0 (latest) — 2015-08-12

## README

# sql-templater
Simple SQL templates.
### Templates syntax
Will be appended later.
### Example
main.sql:
```sql
-- Simple query
-- [ Get items ]
SELECT  *
FROM    "item"
WHERE   "supplier" IN (:suppliers)
;
-- ;


-- A fragment of the query is used many times
-- [ Item name with clothing size ]
CASE
    WHEN "item"."clothing_size" IS NULL THEN "item"."name"
    ELSE "item"."name" || ' (size ' || "item"."clothing_size" || ')'
END AS "name"
-- ;

-- Query with the substitution
-- [ Get item by SKU ]
SELECT  "id",
        "images",
        :[ Item name with clothing size ]
FROM    "item"
WHERE   "sku" = :sku
AND     "store" = :storeId
LIMIT   1
;
-- ;
```

main.js:
```javascript
'use strict';
var templater = require('sql-templater')('./main.sql'),
    sql;  // Type of returning value is 'string'

sql = templater('GET ITEMS', {  // Case does not matter
    suppliers: [1, 2, 3]
});
console.log(sql);
/* Result:
SELECT  *
FROM    "item"
WHERE   "supplier" IN (1, 2, 3)
;
*/

sql = templater('Get item by SKU', {
    storeId: 10,
    sku: 'abcde'
});
console.log(sql);
/* Result:
SELECT  "id",
        "images",
CASE
    WHEN "item"."clothing_size" IS NULL THEN "item"."name"
    ELSE "item"."name" || ' (size ' || "item"."clothing_size" || ')'
END AS "name"
FROM    "item"
WHERE   "sku" = 'abcde'
AND     "store" = 10
LIMIT   1
;
*/
```

---
_Source: https://npm.io/package/sql-templater · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
