citizenken / sails-mysql

MySQL adapter for Sails.js

Sails-MySQL Adapter

MySQL adapter for the Sails framework and Waterline ORM. Allows you to use MySQL via your models to store and retrieve data. Also provides a query() method for a direct interface to execute raw SQL commands.

Installation

Install from NPM.

# In your app:
$ npm install sails-mysql

Sails Configuration

Add the mysql config to the config/connections.js file. Basic options:

module.exports.connections = {
  mysql: {
    module    : 'sails-mysql',
    host      : 'localhost',
    port      : 3306,
    user      : 'username',
    password  : 'password',
    database  : 'MySQL Database Name'

    // OR (explicit sets take precedence)
    module    : 'sails-mysql',
    url       : 'mysql2://USER:PASSWORD@HOST:PORT/DATABASENAME'

    // Optional
    charset   : 'utf8',
    collation : 'utf8_swedish_ci'
    defaultTableCharset   : 'utf8'
    defaultTableCollation : 'utf8_general_ci'
  }
};

And then change default model configuration to the config/models.js:

module.exports.models = {
  connection: 'mysql'
};

Run tests

You can set environment variables to override the default database config for the tests, e.g.:

$ WATERLINE_ADAPTER_TESTS_PASSWORD=yourpass npm test

Default settings are:

{
  host: process.env.WATERLINE_ADAPTER_TESTS_HOST || 'localhost',
  port: process.env.WATERLINE_ADAPTER_TESTS_PORT || 3306,
  user: process.env.WATERLINE_ADAPTER_TESTS_USER || 'root',
  password: process.env.WATERLINE_ADAPTER_TESTS_PASSWORD || '',
  database: process.env.WATERLINE_ADAPTER_TESTS_DATABASE || 'sails_mysql',
  pool: true,
  connectionLimit: 10,
  waitForConnections: true
}

More Resources

• Stackoverflow
• #sailsjs on Freenode (IRC channel)
• Twitter
• Professional/enterprise
• Tutorials
• Waterline (ORM)
• 

License

MIT © 2014 Mike McNeil, Balderdash & contributors

Sails is free and open-source under the MIT License.

See the MySQL Logo Usage Guidelines for more information on our use of the MySQL logo.