node package manager


a postgreSQL adapter for Waterline and Sails.js

PostgreSQL Sails/Waterline Adapter

A Waterline adapter for PostgreSQL. May be used in a Sails app or anything using Waterline for the ORM.

Install is through NPM.

$ npm install sails-postgresql

The following config options are available along with their default values:

config: {
  database: 'databaseName',
  host: 'localhost',
  user: 'root',
  password: '',
  port: 5432,
  poolSize: 10,
  ssl: false

Alternatively, you can supply the connection information in URL format:

config: {
  url: 'postgres://username:password@hostname:port/database',
  ssl: false

We are also testing features for future versions of waterline in postgresql. One of these is case sensitive string searching. In order to enable this feature today you can add the following config flag:

postgresql: {
  url: 'postgres://username:password@hostname:port/database',
  wlNext: {
    caseSensitive: true

You can use model level config options to specify a schema to use. This is done by adding the meta key schemaName.

module.exports = Waterline.Collection.extend({
  tableName: 'user',
  meta: {
    schemaName: 'foo'
  identity: 'user',
  connection: 'myAwesomeConnection',
  attributes: {
    name: 'string'

Test are written with mocha. Integration tests are handled by the waterline-adapter-tests project, which tests adapter methods against the latest Waterline API.

To run tests:

$ npm test

Waterline is a new kind of storage and retrieval engine. It provides a uniform API for accessing stuff from different kinds of databases, protocols, and 3rd party APIs. That means you write the same code to get users, whether they live in mySQL, LDAP, MongoDB, or Facebook.

To learn more visit the project on GitHub at Waterline.