jugglingdb/postgres-adapter

README

JugglingDB-Postgres

PostgreSQL adapter for JugglingDB.

Usage

To use it you need jugglingdb@0.2.x.

Setup dependencies in package.json:

{
  ...
  "dependencies": {
    "jugglingdb": "0.2.x",
    "jugglingdb-postgres": "latest"
  },
  ...
}

Use:

    var Schema = require('jugglingdb').Schema;
    var schema = new Schema('postgres', {
        database: 'myapp_test',
        username: 'postgres'
        // host: 'localhost',
        // port: 5432,
        // password: s.password,
        // database: s.database,
        // ssl: true,
        // debug: false
    });

Additional Features

Support for float datatypes, ala the mysql adapter. Just add dataType: 'float' to your column properties:

var Model = schema.define('Model', {
  realNumber: {type: Number, dataType: 'float'}
});

Support for single and multi-column indexes, ala the mysql adapter. Single column indexes are specified by adding index: true to the column properties. Unique single-column indexes are created by adding unique: true to the column properties (it is unnecessary to also specify index: true since it is implied). Multi-column indexes are added by specifying indexes in the settings hash of the schema.define method. Single-column indexes may also be specified this way if you want to have a little more control over their options. Each key in the indexes hash is the name of the index, and the value is a hash which specifies the index properties:

var Model = schema.define('Model', {
  column1: {type: Number, index: true},
  column2: {type: Number}
}, {
  indexes: {
    indexName1: {
      columns: 'column1, column2',
      type: 'btree'
    }
  }
});

The full list of supported index properties are:

{
  columns: 'comma, delimited, list, of, columns',
  keys: ['array', 'of', 'columns'],   // takes precedence over "columns"!
  type: 'TYPE',                       // 'btree', 'hash', etc
  kind: 'KIND'                        // 'unique' is the only valid option
}

See the postgres documentation for more information about type and kind.

Support for arbitrary where clauses:

Model.all({where: {arbitrary: 'RANDOM STRING DOING ANYTHING'}}, function(err, models) {
  ...
});

You can still have columns named arbitrary in your models; those will take precedence if found.

Note: This is a perfect moment to discuss the unwise nature of passing filter objects from the client to the server. Don't do it. Expose endpoints which then call all() with known arguments.

Support for an 'or' operator in where clauses. For example, you can look for models which either have a matching userId, or the same ip with a created date greater than one day ago:

var where = {
  or: [{
    userId: 5
  },{
    ip: req.ip,
    created: {
      gt: oneDayAgo
    }
  }]
}
Model.all({where: where}, function(err, models) {
  ...
});

Similar to the arbitrary operator above, any column named or in your model will take precedence if found.

Running tests

docker run --name postgres -p 5432:5432 -e POSTGRES_PASSWORD= -d postgres
docker exec $(docker ps -f name=postgres -q) \
       psql -c 'create database myapp_test;' -U postgres

export POSTGRES_HOST=`docker-machine ip your-docker-machine-name`

npm test

MIT License

Copyright (C) 2012 by Anatoliy Chakkaev

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.