# tosql

> make building sql more easier.

Latest version **0.0.3** (published 2015-12-22) · ISC license · 0 weekly downloads

## Install

```sh
npm install tosql
pnpm add tosql
yarn add tosql
bun add tosql
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.3 |
| Published | 2015-12-22 |
| First published | 2015-12-22 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 (+5 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Onionkings |
| Maintainers | onionkings |
| Keywords | sql, mysql |

## Links

- npm: https://www.npmjs.com/package/tosql
- Repository: https://github.com/ManitoYu/tosql
- Homepage: https://github.com/ManitoYu/tosql#readme
- Issues: https://github.com/ManitoYu/tosql/issues
- npm.io page: https://npm.io/package/tosql

## Dependencies (1)

- [lodash](https://npm.io/package/lodash.md) ^3.10.1

## Recent versions

- 0.0.3 (latest) — 2015-12-22

## README

[![tosql](http://www.onionkings.com/tosql.png)](https://github.com/ManitoYu/tosql)

## Introduction

This is a new tool for building sql.  
I will try my best to complete it.  
If you feel that the tool gives you some help, I hope you can star me [ManitoYu](https://github.com/ManitoYu/tosql).

## Examples

```js
var tosql = require('tosql');
var table = tosql('table');
```

### Insert

```js
var sql = table.insert({ name: 'your name', age: 21 });
console.log(sql); // INSERT INTO `table` (`your name`, `age`) VALUES ('yucong', 21)
```

### Field

```js
var sql = table.field(['id', 'name']).select();
console.log(sql); // SELECT `id`, `name` FROM `table`
```

### Where

- ne
- le
- ge
- eq
- gt
- lt
- like
- between
- in

```js
table.where({ id: { ne: 1 } }).select(); // SELECT * FROM `table` WHERE `id` != 1
table.where({ id: { ge: 1, le: 10 } }).select(); // SELECT * FROM `table` WHERE `id` >= 1 AND `id` <= 10
table.where({ name: { like: '%name%' } }).select(); // SELECT * FROM `table` WHERE `name` LIKE '%name%'
table.where([{ id: 1 }, { name: 'name' }]).select(); // SELECT * FROM `table` WHERE (`id` = 1) OR (`name` = 'name')
table.where({ id: 1, name: 'name' }).select(); // SELECT * FROM `table` WHERE `id` = 1 AND `name` = 'name'
table.where({ id: [{ in: [1, 2, 3] }, { between: [10, 20] }] }).select(); // SELECT * FROM `table` WHERE ((`id` IN (1, 2, 3)) OR (`id` BETWEEN 10 AND 20))
```

### Delete

```js
table.where({ id: 1 }).delete(); // DELETE FROM `table` WHERE `id` = 1
```

If you create a model with primary key, you can do this more easier.
```js
var table = tosql('table', 'id');
table.delete(1); // DELETE FROM `table` WHERE `id` = 1
```

### Update

```js
table.where({ id: 1 }).update({ age: 21 }); // UPDATE `table` SET `age` = 21 WHERE `id` = 1
```

The same as delete, you can also do it as follow.
```js
var table = tosql('table', 'id');
table.update({ name: 'name' }, 1); // UPDATE `table` SET `name` = 'name' WHERE `id` = 1
```

### Join

```js
// set the map of relations
tosql.relations([
  { table: 'table1_id', table1: 'id' }
]);
// set the alias of table
tosql.config('table', { alias: 't' });
tosql.config('table1', { alias: 't1' });
var table = tosql('table');
table.join('table1').where({ 't.id': 1 }).select(); // SELECT * FROM `table` `t` LEFT JOIN `table1` `t1` ON `t1`.`id` = `t`.`table1_id` WHERE `t`.`id` = 1
```

### Limit

```js
var table = tosql('table');
table.limit(0, 10).select(); // SELECT * FROM `table` LIMIT 0, 1
```

### Order

```js
var table = tosql('table');
table.where({ status: 1 }).order('id').select(); // SELECT * FROM `table` WHERE `status` = 1 ORDER BY `id` DESC
table.order('time', false).select(); // SELECT * FROM `table` ORDER BY `time` ASC
```

### Group

```js
var table = tosql('table');
table.field(['sex', { sum: 'age' }, { avg: 'age' }]).group('sex').select(); // SELECT `sex`, SUM(`age`), AVG(`age`) FROM `table` GROUP BY `sex`
```

### Having

```js
var table = tosql('table');
table.field(['sex', { sum: 'sex' }]).group('sex').having({ sum: 'sex' }, { gt: 1 }).select(); // SELECT `sex`, SUM(`sex`) FROM `table` GROUP BY `sex` HAVING SUM(`sex`) > 1
```

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