piggy

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

###Piggy.

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 = {
    }

###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, release )
     */
    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
 
    // flatten results from stored procedures. 
    Piggy#flatten = function ( Object results [String sp_key ] ) : Array

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.