devbox-pg

DEVBOX-PG

Encapsulated functions execute procedures for postgres (pg-db).

Installation

npm install devbox-pg

Use Example

require('devbox-pg')(config);

Only works on Node v6 and above

Check the operation list below.

---

INPUTS

• INPUT
• INPUTMANY
• INPUTNAME
• OBJECT

EXECUTES

• EXECUTE
• EXECUTEONE

---

Example Config

 
let config = {
    user: 'user',
    database: 'database',
    password: 'pass',
    host: 'host',
    port: 5432,
    max: 10,
    idleTimeoutMillis: 30000
};;
 

INPUTS

INPUT (parameter)

 
const pg = require('devbox-pg')(config);
 
pg.request()
    .input('param1')
    .input('param2')
    .input('param3')
    .execute('procedureName', (err, data) => {
        if (err)
            return console.log(err);
 
        console.log(data);
    });

INPUTMANY (parameters)

const pg = require('devbox-pg')(config);
 
pg.request()
    .input('param1','param2','param3')
    .execute('procedureName', (err, data) => {
        if (err)
            return console.log(err);
 
        console.log(data);
    });

INPUTNAME (parameterName,value)

const pg = require('devbox-pg')(config);
 
pg.request()
    .inputName('parameterName','value')
    .inputName('parameterName','value')
    .inputName('parameterName','value')
    .execute('procedureName', (err, data) => {
        if (err)
            return console.log(err);
 
        console.log(data);
    });

OBJECT (object,prefix)

Prefix optional

const pg = require('devbox-pg')(config);
 
let obj = {
    parameterName: 'parameterValue',
    parameterName1: 'parameterValue1',
    parameterName2: 'parameterValue2',
}
/* O Nome dos atributos do objeto deve ter o mesmo nome dos parâmetros */
/* O Objeto nunca deve possuir mais atributos do que parâmetros esperados pela procedure */
/* Caso houver um padrão de prefixo, ele pode ser passado no 2 parâmetro do metodo -object- */
 
pg.request()
    .object(obj, /*Optional prefix name*/)
    .inputName('paramName','value') /* Opicional junto com object */
    .execute('procedureName', (err, data) => {
        if (err)
            return console.log(err);
 
        console.log(data);
    });

EXECUTES

EXECUTE (procedureName, callback)

Return list results

const pg = require('devbox-pg')(config);
 
pg.request()
    .execute('procedureName', (err, data) => {
        if (err)
            return console.log(err);
 
        console.log(data);
    });

EXECUTEONE (procedureName, callback)

Return single result

const pg = require('devbox-pg')(config);
 
pg.request()
    .executeOne('procedureName', (err, data) => {
        if (err)
            return console.log(err);
 
        console.log(data);
    });