Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/arshadkazmi42/genql
Helper for sql query generation and formatting
https://github.com/arshadkazmi42/genql
generate-sql gensql mysql postgresql query query-generator sql sql-query sqlite
Last synced: 3 months ago
JSON representation
Helper for sql query generation and formatting
- Host: GitHub
- URL: https://github.com/arshadkazmi42/genql
- Owner: arshadkazmi42
- License: mit
- Created: 2019-08-01T17:15:01.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-10-22T20:13:09.000Z (over 2 years ago)
- Last Synced: 2024-10-07T06:41:16.972Z (4 months ago)
- Topics: generate-sql, gensql, mysql, postgresql, query, query-generator, sql, sql-query, sqlite
- Language: JavaScript
- Size: 107 KB
- Stars: 4
- Watchers: 1
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# genql
[](https://github.com/arshadkazmi42/genql/actions/workflows/nodejs.yml)
[](https://www.npmjs.com/package/genql)
[](https://www.npmjs.com/package/genql)
[](https://github.com/arshadkazmi42/genql)
[](https://github.com/arshadkazmi42/genql/blob/master/LICENSE)
[](https://github.com/arshadkazmi42/genql/graphs/contributors)
[](https://github.com/arshadkazmi42/genql/commits/master)
Helper for SQL query generating and formatting
## Install
```
npm i genql
```
## Usage
```javascript
const GenQL = require('genql');
const model = require('./data/model.json');
const $ = new GenQL(model);
const fields = $._select();
const fieldPrefix = $._select('$');
console.log(fields);
console.log(fieldPrefix);
// OUTPUT -> {{fields}}
// [
// 'id',
// 'name',
// 'email',
// 'COALESCE(NULLIF(class, ''), cls)',
// 'status'
// ]
// OUTPUT -> {{fieldPrefix}}
// [
// '$.id',
// '$.name',
// '$.email',
// 'COALESCE(NULLIF($.class, ''), cls)',
// '$.status'
// ]
```
## API
- **`_default(field)`**
- Returns default value for the field from model
- ***`Params`***
- field (string)
- **`_insert(prefix)`**
- Returns all the fields from model, except the `auto` fields. Uses optional `prefix` and appends it to column name
- ***`Params`***
- prefix (String) {Optional}
- **`_join(prefix)`**
- Returns all the fields from model, appended with `join_key` as prefix which is defined in model. Uses optional `prefix` and appends it to column name
- ***`Params`***
- prefix (String) {Optional}
- **`_findPrivate(prefix)`**
- Returns all the column which have `private` flag defined with it in the model. Uses optinal `prefix` and appends it to column names
- ***`Params`***
- prefix (String) {Optional}
- **`_removePrivate(data)`**
- Removes all the values from `data` object which are marked as private column in model
- ***`Params`***
- data {JSON}
- **`_values(data)`**
- Returns list of values from data object for all the columns from model which are not marked as private
- ***`Params`***
- data (JSON)
- **`_select(prefix)`**
- Returns all the fields from model and uses alternate column if defined in model. Uses optional `prefix` and appends it to column name
- ***`Params`***
- prefix (String) {Optional}
- **`_update(fields, data)`**
- Returns list of values from data for the input fields
- ***`Params`***
- fields (Array)
- data (JSON)
> Note: Sample model definition is available in [data/model.json](data/model.json)
## Contributing
Interested in contributing to this project?
You can log any issues or suggestion related to this library [here](https://github.com/arshadkazmi42/genql/issues/new)
Read our contributing [guide](CONTRIBUTING.md) on getting started with contributing to the codebase