piggy

Piggy, a minimal wrapper for a single generic-pool of node-postgres clients

npm install piggy
12 downloads in the last week
30 downloads in the last month

Piggy.

build status NPM version

Piggy, a minimal wrapper for a single generic-pool of node-postgres clients.

Install

$ npm install piggy [-g]

require :

var Piggy  = require( 'piggy' );

Run Tests

$ cd piggy/
$ npm test

Constructor

Create an instance. Arguments within [ ] are optional.

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

Options

// 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
    }

Properties

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

Methods

Arguments within [ ] are optional.

    /*
     * 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

MIT License

Copyright (c) 2012 < Guglielmo Ferri : 44gatti@gmail.com >

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

npm loves you