orm2 中文文档 3. 定义模型

译者:飞龙

来源:Defining Models

连接之后,你可以使用连接对象(db)来定义你的模型。你需要指定模型的名称,一个用于描述的属性和一些(可选的)选项。下面是一个简短的例子:

var Person = db.define('person', {
  id:      {type: 'serial', key: true}, // the auto-incrementing primary key
  name:    {type: 'text'},
  surname: {type: 'text'},
  age:     {type: 'number'}
}, {
  methods : {
    fullName: function() {
      return this.name + ' ' + this.surname;
    }
  }
});

这个模型叫做person(通常也是数据库里面表的名称),它有三个属性(namesurname为文本,age为数值)。如果你自己不指定任何键的话,默认的id: { type: 'serial', key: true }会添加进来。在这个例子中,有个模型方法叫做fullName。下面是这个模型的使用方法的示例:

Person.get(73, function(err, person) {
  if (err) throw err;

  console.log('Hi, my name is ' + person.fullName());
});

这会获取id=73person对象,并且打印出它的名字和姓氏。其它类型的可用属性请见这里

API

/**
 * @param {Object} props Property definitions
 * @param {Object} opts Options
 */
db.define(props, opts)

db.define()接收的第一个对象(第二个参数)被称为属性对象,它定义了所有的属性

第二个对象指定了额外的选项:

选项名称类型描述
collectionString覆写数据库中表的名称
methodsObject模型实例上的额外方法,它会被设置到实例上。
hooksObject用户定义的钩子或回调
validationsObject用户定义的验证器
idArray为了支持在properties上设置key: true而不提倡使用
cacheBoolean允许你开启或者禁用单例行为。它叫做cache,但是和缓存毫无关系。
autoSaveBoolean不推荐。在属性修改时自动保存模型。
autoFetchBoolean是否自动获取关联
autoFetchLimitNumber自动获取关联的深度
cascadeRemoveBoolean删除实例时是否要删除关联
    原文作者:飞龙
    原文地址: https://segmentfault.com/a/1190000004280050
    本文转自网络文章,转载此文章仅为分享知识,如有侵权,请联系博主进行删除。
点赞