piggy

var Piggy  = require( 'piggy' );

Piggy( [ Object opt ] ) : Piggy
// or
new Piggy( [ Object opt ] ) : Piggy

// default options are listed
    var options = {
        /*
        * default pg options
        * refer to https://github.com/brianc/node-postgres
        */
        pg : {
            user : 'postgres',
            password : 'postgres',
            database : 'template1',
            host : '127.0.0.1',
            port : 5432,
            ssl : false
        },
        /*
         * default pool opt
         * refer to https://github.com/coopernurse/node-pool#documentation
         */
        gp : {
            name : 'postgres',
            max : 20,
            // optional. if you set this, make sure to drain() (see step 3)
            min : 4,
            // specifies how long a resource can stay idle in pool before being removed
            idleTimeoutMillis : 60 * 60 * 1000,
            // if true, logs via console.log - can also be a function
            log : false,
            /*
             * boolean that specifies whether idle resources at or below 
             * the min threshold should be destroyed/re-created.
             */
            refreshIdle : true,
            // frequency to check for idle resources
            reapIntervalMillis : 30 * 1000,
            /*
             * int between 1 and x - if set, borrowers can specify their
             * relative priority in the queue if no resources are available.
             */
            priorityRange : 1,
            /*
             * function that accepts a pooled resource and returns true
             * if the resource is OK to use, or false if the object is 
             * invalid. Invalid objects will be destroyed. This function
             * is called in acquire() before returning a resource from
             * the pool. Optional. Default function always returns true.
             */
            validate : emptyFn
            /*
             * create and destroy methods are internally defined.
             */
        },
        debug : false
    }

// a property that holds the initial config object:
Piggy.options : Object
// a property that holds the resource pool ( generic-pool module ).
Piggy.pool : Object
 

    /*
     * acquire a resource from the pool.
     * Function cback gets 3 arguments ( err, client, releaseFn );
     * use releaseFn for sending back the client resource to the pool.
     */
    Piggy#acquire( [ Function cback [, Number priority ] ] ) : undefined
 
    // shutdown / kill the resource pool
    Piggy#kill( [ Function cback ] ) : undefined
 
    // restart the resource pool after a shutdown.
    Piggy#restart( [ Object opt [, Function cback ] ] ) : undefined
 
    /*
     * Utility method to flatten results from stored procedures.
     * Use sp_key to save sp name in the result object,
     */
    Piggy#flatten( Object results [, Boolean sp_key || String sp_key ] ) : Array