Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tehshrike/joi-sql
Create Joi validation code for MySQL databases
https://github.com/tehshrike/joi-sql
duck-typing joi mysql sql
Last synced: 6 days ago
JSON representation
Create Joi validation code for MySQL databases
- Host: GitHub
- URL: https://github.com/tehshrike/joi-sql
- Owner: TehShrike
- Created: 2015-04-24T01:24:31.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2020-08-31T21:39:14.000Z (about 4 years ago)
- Last Synced: 2024-11-02T04:51:45.920Z (13 days ago)
- Topics: duck-typing, joi, mysql, sql
- Language: JavaScript
- Size: 47.9 KB
- Stars: 21
- Watchers: 5
- Forks: 7
- Open Issues: 3
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# joi-sql
Point it at your local database, and it spits out a [Joi](https://github.com/hapijs/joi) object validator.
[](https://travis-ci.org/TehShrike/joi-sql)
## Install
```sh
npm install joi-sql
```
(`npm install -g joi-sql` if you want to use it from the command-line)
The only "breaking" change from 1.x to 2.x is that support for versions of node older than 8 was dropped.
## Usage
### CLI
```sh
joi-sql --host=localhost --user=root --password=abc123 --schema=awesomedb --table=customer --camel
```
`host`, `user`, `password`, and `camel` are all optional. `schema` and `table` are not.
If `camel` is set, then column names are converted to camel case identifiers.
Spits out something like:
```js
Joi.object({
projectId: Joi.required().invalid(null).number().integer().max(4294967295).min(0),
contactId: Joi.required().invalid(null).number().integer().max(4294967295).min(0),
dateCreated: Joi.required().invalid(null).date(),
engineerId: Joi.number().integer().max(4294967295).min(0),
name: Joi.required().invalid(null).string().allow('').max(200),
engineeringProject: Joi.required().invalid(null).boolean(),
printingProject: Joi.required().invalid(null).boolean(),
activeProjectStateId: Joi.required().invalid(null).number().integer().max(4294967295).min(0),
startDate: Joi.date(),
done: Joi.required().invalid(null).boolean(),
doneDate: Joi.date(),
deadReason: Joi.string().allow('').max(65535),
quotedEngineeringHours: Joi.number().precision(1).less(10000),
actualEngineeringHours: Joi.number().precision(1).less(10000),
engineeringDueDate: Joi.date(),
printParts: Joi.string().allow('').max(65535),
printQuantity: Joi.number().integer().max(8388607).min(-8388608),
printTimeHours: Joi.number().precision(1).less(10000),
printDueDate: Joi.date(),
paymentReceived: Joi.required().invalid(null).boolean(),
contactDate: Joi.date(),
replyDate: Joi.date(),
quoteDate: Joi.date(),
followUpDate: Joi.date(),
notes: Joi.string().allow('').max(65535),
version: Joi.required().invalid(null).number().integer().max(4294967295).min(0)
})
```
### Programmatic
Returns a promise that resolves to a string containing the code snippet above.
```js
const joiSql = require('joi-sql')
joiSql({
host: 'localhost',
user: 'root',
password: 'abc123',
schema: 'awesomedb',
table: 'customer',
camel: true
}).then(result => {
typeof result // => 'string'
})
```
You may also pass in an optional `connection` property which must be a [`mysql`](https://github.com/mysqljs/mysql) connection instance.
Pull requests welcome.
## License
[WTFPL](http://wtfpl2.com/)