orm2 中文文档 1. 连接到数据库

译者：飞龙

来源：Connecting to Database

在连接之前，你需要一个受支持的驱动。下面是一些测试过的驱动及其版本，把你所需要的加入到package.json中。

驱动	npm 包	版本
mysql	mysql	2.0.0-alpha9
postgres redshift	pg	2.6.2 [1]
sqlite	sqlite3	2.1.7
mongodb	mongodb	1.3.19

[1] 如果你要连接到Heroku，请使用版本2.5.0。

这些是测试过的版本，使用其它的版本（新的或者旧的）带来的风险由你自己承担。

例如，使用MySQL要这样做：

$ npm install --save mysql@2.0.0-alpha8

你可以传递一个URL字符串来连接数据库，其中scheme为受支持的驱动，或者你可以传递一个带有连接参数的Object。

var orm = require('orm');

orm.connect('mysql://root:password@localhost/test', function(err, db) {
  if (err) return console.error('Connection error: ' + err);

  // connected
  // ...
});

回调函数只在连接建立成功（或失败）时调用。如果你愿意的话，可以不传入回调函数，而是监听connect事件。

var orm = require('orm');

var db = orm.connect('mysql://root:password@localhost/test');

db.on('connect', function(err) {
  if (err) return console.error('Connection error: ' + err);

  // connected
  // ...
});

连接URL遵循下面的语法：driver://username:password@hostname/database?option1=value1&option2=value2..

可选参数为：

• debug（默认为false）：将连接输出到控制台；
• pool（默认为false）：使用驱动内建的组件管理连接池（仅对mysql和postgres有效）；
• strdates（默认为false）：以字符串形式保存日期（仅对sqlite有效）；
• timezone（默认为local）：在数据库中使用指定的时区储存日期（仅对mysql和postgres有效）；

debug和pool也可以使用settings对象来设置。

连接到多个数据库

ORM模型受数据库连接约束，所以如果你需要“多租户”，即连接到不同的服务器或数据库，你可以使用像下面这样的方法：

// db.js
var connections = {};

function setup(db) {
  var User = db.define('user', ...);
  var Shirt = db.define('shirt', ...);
  Shirt.hasOne('user', User, ...);
}

module.exports = function(host, database, cb) {
  if (connections[host] && connections[host][database]) {
    return connections[host][database];
  }

  var opts = {
    host:     host,
    database: database,
    protocol: 'mysql',
    port:     '3306',
    query:    {pool: true}
  };

  orm.connect(opts, function(err, db) {
    if (err) return cb(err);

    connections[host] = connections[host] || {};
    connections[host][database] = db;
    setup(db);
    cb(null, db);
  });  
};

// somewhere else, eg, middleware

var database = require('./db');

database('dbserver1', 'main', function(err, db) {
  if (err) throw err;

  db.models.user.find({foo: 'bar'}, function(err, rows) {
    // ...
  });
});

连接是被缓存的，所以模型在每个服务器+数据库上面只会定义一次。由于我们使用了连接池，我们并不需要担心用完所有的连接，而且我们可以一次性执行多个查询。

问题排除

如果你在连接MySQL数据库的时候遇到了如下错误：

Error: connect ECONNREFUSED
    at errnoException (net.js:670:11)
    at Object.afterConnect [as oncomplete] (net.js:661:19)

你可以尝试添加socketPath参数：

var db = orm.connect({
    host:     'localhost',
    database: 'database',
    user:     'user',
    password: 'pass',
    protocol: 'mysql',
    socketPath: '/var/run/mysqld/mysqld.sock',
    port:     '3306',
    query:    {pool: true, debug: true}
});