Install & Compatibility
Where this runs
No compatibility data collected yet for this library.
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
sails-mysql
✓ npm install sails-mysql
✗ require('sails-mysql')
Installed as a Node module, not imported directly. Configure as a datastore adapter in Sails.
sails.config.datastores
✓ // In config/datastores.js:
module.exports.datastores = {
default: {
adapter: 'sails-mysql',
url: 'mysql://root:pass@localhost/my_db'
}
};
✗ require('sails-mysql') as a separate connection
The adapter is configured globally via Sails datastores configuration.
Model.query()
✓ await MyModel.query('SELECT * FROM users WHERE id = $1', [1]);
✗ MyModel.query('SELECT ...')
Use async/await or promises. Raw SQL queries are available on model instances.
Shows installation, configuration, model definition, and creation of a record using sails-mysql.
// 1. Install
// npm install sails-mysql
// 2. Configure datastore in config/datastores.js
module.exports.datastores = {
default: {
adapter: 'sails-mysql',
url: process.env.MYSQL_URL || 'mysql://root:password@localhost/sails_test'
}
};
// 3. Create model (api/models/User.js)
module.exports = {
attributes: {
name: { type: 'string' },
email: { type: 'string', required: true, unique: true }
}
};
// 4. Use in controller
async function createUser(req, res) {
const newUser = await User.create({ name: 'Alice', email: 'alice@example.com' }).fetch();
return res.json(newUser);
}
Errors
Common errors & fixes
Error: connect ECONNREFUSED 127.0.0.1:3306
MySQL server not running or wrong host/port.
fixStart MySQL service and verify MYSQL_URL environment variable.
Error: ER_ACCESS_DENIED_ERROR: Access denied for user 'root'@'localhost'
Invalid credentials in connection URL.
fixCheck username and password in MYSQL_URL; ensure user has proper privileges.
Error: ER_BAD_DB_ERROR: Unknown database 'sails_test'
Database does not exist.
fixCreate database via SQL: CREATE DATABASE sails_test;
Audit
Dependencies
sailsrequiredAdapter for Sails.js framework
waterlinerequiredORM integration
mysql2requiredMySQL client library for Node.js