Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/planetarydev/json-sql-builder
SQLBuilder to translate json dataformat like mongo to SQL
https://github.com/planetarydev/json-sql-builder
json json-sql-builder mongo mysql postgresql sql translate
Last synced: 4 days ago
JSON representation
SQLBuilder to translate json dataformat like mongo to SQL
- Host: GitHub
- URL: https://github.com/planetarydev/json-sql-builder
- Owner: planetarydev
- License: mit
- Archived: true
- Created: 2017-08-21T16:25:56.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2019-07-30T04:56:07.000Z (over 5 years ago)
- Last Synced: 2024-10-31T17:45:19.659Z (16 days ago)
- Topics: json, json-sql-builder, mongo, mysql, postgresql, sql, translate
- Language: JavaScript
- Homepage:
- Size: 392 KB
- Stars: 11
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# json-sql-builder
Writing your SQL-Queries in a way like mongo. Use JSON to define all the queries you like to run.
By default `json-sql-builder` supports the ANSI-SQL language. In addition to this you can specify a dialect like `mysql` or `postgreSQL`.
At this time we will support additional language helpers and operators for:
- [x] ANSI
- [x] MySQL
- [x] PostgreSQL
- [ ] Oracle
- [ ] Microsoft SQL Server
## Current Dev Stage
This repo was no longer maintained, because of a new Version of json-sql-builder. Have a look at [json-sql-builder2](https://github.com/planetarydev/json-sql-builder2)
## Install
```sh
npm install json-sql-builder --save
```
## Getting Started
```javascript
const SQLBuilder = require('json-sql-builder');
// create a new instance of the SQLBuilder and load the language extension for mysql
var sqlbuilder = new SQLBuilder('mysql');
// lets start some query fun
var totalSalary = sqlbuilder.build({
$select: {
$columns: [
'job_title',
{ total_salary: { $sum: 'salary' } }
],
$from: 'people',
$where: {
job_title: { $in: ['Sales Manager', 'Account Manager'] },
age: { $gte: 18 },
country_code: 'US',
},
$groupBy: ['job_title'],
}
});
```
**Result**
```javascript
// totalSalary.sql
SELECT
`job_title`,
SUM(`salary`) AS `total_salary`
FROM
`people`
WHERE
`job_title` IN (?, ?)
AND `age` >= ?
AND `country_code` = ?
GROUP BY
`job_title`
// totalSalary.values
['Sales Manager', 'Account Manager', 18, 'US']
// general output
queryOutput = {
sql: 'Your SQL-query-string'
values: ['Array', 'with', 'all', 'Query-values']
timeout: 10000 // depends on the options
}
```
# Release notes
### 1.0.19 Bugfixing
- Join Support for MySQL and PostgreSQL should work now
- Fix Support for Sub-Select's with AS clause
### 1.0.17+18 Bugfixing, Update docs
- Parameterized queries for PostgreSQL using $create operator. The params will now safely escaped by pg-format because PostgreSQL does not support parameters on CREATE statements.
### 1.0.16 Add `CREATE VIEW` Support with new operators and helpers
- ANSI using `$create: { $view: 'myView', $select: {...} }`
```javascript
var query = sqlbuilder.build({
$create: {
$view: { $cor: 'v_people' },
$select : {
$from: 'people',
$columns: [
'first_name',
'last_name'
]
}
}
});
// OUTPUT
CREATE OR REPLACE VIEW `v_people` AS
SELECT
`first_name`,
`last_name`
FROM
`people`;
```
### 1.0.15 Add Support for ANSI `JOIN` operators
- INNER JOIN
- LEFT JOIN
- RIGHT JOIN
- FULL OUTER JOIN
```javascript
var query = sqlbuilder.build({
$select: {
$from: 'public.users',
$joins: {
'public.users_profiles': { $as: 'profile', $innerJoin: { 'public.users.id': { $eq: { $column: 'profile.user_id' } } } },
'public.users_likes': { $as: 'likes',
$leftJoin: {
$and: [
{ 'likes.user_id': { $eq: { $column: 'public.users.id' } } },
{ 'likes.score': { $gt: 1 } }
]
}
}
}
}
});
```
### 1.0.15 Add PostgreSQL JSON helpers
- $rowToJson
- $jsonBuildObject
```javascript
// Example using $jsonBuildObject
var query = sqlbuilder.build({
$select: { $columns: [
{ peopleData: { $jsonBuildObject: { firstName: 'John', lastName: 'Doe' } } }
] }
});
SELECT
json_build_object('firstName', $1, 'lastName', $2) AS "peopleData"
FROM
"people"
// Example using $rowToJson
var query = sqlbuilder.build({
$select: {
$from: 'people',
$columns: [
{ peopleData: { $rowToJson: 'people' } }
]
}
});
SELECT
row_to_json("people") AS "peopleData"
FROM
"people";
```
### 1.0.14 Add `CREATE INDEX` operators and helpers for
- ANSI using `$create: { $index: 'myidx', $table: 'mytable', $columns: {...} }`
- Move `$ine` to Basic Helpers and support Boolean and String expressions
- Update tests and docs
```javascript
var query = sqlbuilder.build({
$create: {
$index: 'idx_people_last_name',
$table: 'people',
$columns: {
last_name: { $asc: true },
first_name: { $asc: true },
},
$using: 'BTREE'
}
}
// OUTPUT
CREATE INDEX `idx_people_last_name` ON `people` USING BTREE (
`last_name` ASC,
`first_name` ASC
);
```
### 1.0.13 Add `CREATE TABLE` operators and helpers for
- ANSI
- PostgreSQL
- MySQL
- Update tests and docs
```javascript
var query = sqlbuilder.build({
$create: {
$table: 'users',
$define: {
_id: { $column: { $type: 'VARCHAR', $length: 32, $notNull: true } },
username: { $column: { $type: 'TEXT' } },
first_name: { $column: { $type: 'TEXT' } },
last_name: { $column: { $type: 'TEXT', $default: 'John' } },
createdAt: { $column: { $type: 'DATETIME', $notNull: true } },
pk_users: { $constraint: { $primary: true, $columns: '_id' } },
uc_users_username: { $constraint: { $unique: true, $columns: 'username' } }
}
}
});
// OUTPUT
CREATE TABLE `users` (
`_id` VARCHAR (32) NOT NULL,
`username` TEXT,
`first_name` TEXT,
`last_name` TEXT DEFAULT ?,
`createdAt` DATETIME NOT NULL,
CONSTRAINT `pk_users` PRIMARY KEY (`_id`),
CONSTRAINT `uc_users_username` UNIQUE (`username`)
);
```
### 1.0.12 Add helpers and operators for **postgreSQL**
- `LIMIT` and `LIMIT ALL` using `$limit`
- `OFFSET` using `$offset`
- add `sqlDialect` property to sqlBuilder to use it inside of helper-functions
### 1.0.11 Add helpers and operators for **postgreSQL**
- `ON CONFLICT` clause using `$confict`
- Update documetation
### 1.0.10 Add helpers and operators for **postgreSQL**
- Function `json_agg()` using `$jsonAgg`
- Function `to_json()` using `$json`