joi-sql

Point it at your local database, and it spits out a Joi object validator.

Install

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

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:

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.

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 connection instance.

Pull requests welcome.

License

WTFPL