https://github.com/zweifisch/cadena
cadena helps you to write safer sql
https://github.com/zweifisch/cadena
sql
Last synced: about 2 months ago
JSON representation
cadena helps you to write safer sql
- Host: GitHub
- URL: https://github.com/zweifisch/cadena
- Owner: zweifisch
- License: mit
- Created: 2016-11-15T12:42:29.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-09-03T11:15:34.000Z (over 6 years ago)
- Last Synced: 2025-02-28T18:45:52.895Z (3 months ago)
- Topics: sql
- Language: JavaScript
- Homepage:
- Size: 50.8 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# cadena
[![NPM Version][npm-image]][npm-url]
[![Build Status][travis-image]][travis-url]
[![Node.js Version][node-version-image]][node-version-url]
cadena helps you to write safer SQL
- supports parameterized query
- `run()` returns promise
- supports mysql, sqlite3 and rqlite
## usage
```sh
npm install --save cadena
```
```js
const { select, connect, query, sql } = require('cadena')
const db = connect('mysql', 'mysql://guest:[email protected]/test')
select('name', 'id')
.from('players')
.where({score: { '>=': 90 }})
.limit(0, 10)
.orderBy('score').desc().run(db)
// just get SQL as string
select().from('players').toString()
let id = '33b27b80-bee3-4d1b-aa9a-231bf250f344'
sql`select * from tbl where id=${id}`.run(db)
sql`select * from tbl where id=${id}`.toString()
// select * from tbl where id='33b27b80-bee3-4d1b-aa9a-231bf250f344'
```
### select
```js
select(['name', 'id']) // SELECT name, id
select() // SELECT *
```
#### where
```js
where({key: 'value'}) // WHERE `key` = 'value'
where({
score: {between: [80, 90]},
name: {contains: 'alberto'}
group: ['A', 'B']
}) // WHERE `score` BETWEEN (80, 90) AND `name` LIKE '%alberto%' AND `group` IN ('A', 'B')
where({key: {'<': min}}).or({key: {'>': max}}) // WHERE `key` < min OR `key` > max
```
undefined values are ignored
```js
where({key: undefined}) // not output
where({key: undefined, key2: 'value'}) // WHERE `key2` = 'value'
where({key: undefined}).or({key2: 'value'}) // WHERE `key2` = 'value'
```
nested and/or
```js
where(and(
or({ n: 1 }, { n: 2 }),
{ k: 1 }))
// WHERE (`n` = 1 OR `n` = 2) AND `k` = 1
```
a more verbose form
```js
where({
$and: [
{ $or: [{n: 1}, {n: 2}] },
{ k: 1 }
]
})
```
#### orderBy
```js
orderBy('field1', 'field2') // ORDER BY `field1`, `field2`
orderBy(['field1', 'field2']) // ORDER BY `field1`, `field2`
orderBy(['-field1', 'field2']) // ORDER BY `field1` DESC, `field2`
orderBy('field1', 'ASC', 'field2', 'DESC') // ORDER BY `field1` ASC, `field2` DESC
orderBy('field1').desc().orderBy('field2').asc() // ORDER BY `field1` DESC, `field2` ASC
```
#### join
```js
select('name', 'id').from('tbl').leftJoin('tbl2').on({tbl.id: "tbl2.tblId"})
```
### subquery
```js
let tbl = select('name', 'id').from('tbl')
select().from(tbl) // SELECT * FROM (SELECT `name`, `id` FROM `tbl`)
```
### count
```js
let query = select().from('tbl').where({key: value}).orderBy('created_at').desc()
query.count().sql // SELECT COUNT(*) AS `total` FROM `tbl` WHERE `key` = 'value'
```
### insert
```js
insert({name: 'foo', score: 1}).into('players')
insert(['name', 'score'], [['foo', 1], ['bar', 2]]).into('players')
```
### upsert
```js
upsert({name: 'foo', score: 1}).into('players')
```
### update
```js
update('players').set({name: 'foo', score: 1}).where({id: 1})
```
```js
update('players').set('name', 'foo').set('score', 1).limit(1)
```
### delete
```js
del('players').where({id: 1})
```
```js
del('players').where({name: {contains: 'alberto'}}).limit(1)
```
### parameterized query
```js
const { sql } = require('cadena')
let name = 'first'
let id = 1
sql`insert into tbl set name=${name} where id=${id}`.run(db)
```
### database intergration
mysql
```js
const db = cadena.connect('mysql', 'mysql://root:@127.0.0.1/test')
```
sqlite3
```js
const db = cadena.connect('sqlite3', ':memory:')
```
rqlite
```js
const db = cadena.connect('rqlite', 'http://127.0.0.1:4001')
```
[npm-image]: https://img.shields.io/npm/v/cadena.svg?style=flat
[npm-url]: https://npmjs.org/package/cadena
[travis-image]: https://img.shields.io/travis/zweifisch/cadena.svg?style=flat
[travis-url]: https://travis-ci.org/zweifisch/cadena
[node-version-image]: https://img.shields.io/node/v/cadena.svg
[node-version-url]: https://nodejs.org/en/download/