建立关联时，哪些方法/mixin sequelize 添加到模型中? [英] What methods/mixins sequelize adds to the models when an association is made?

问题描述

在浏览

要理解此表的含义，请回想一下在该文档页面的开头，它说在下面的 API 参考中，将关联的名称添加到方法中".其中最令人困惑的部分是不清楚何时应该添加名称的单数形式以及何时应该添加复数形式.但是，尽管文档没有明确说明这一点，但我向您保证，您可以仅凭常识进行猜测.如果您认为这两个版本都有意义(例如，对于 add)，您会惊讶于实际上两个版本都可用.因此，从上表中，我们可以得出结论:

• 添加到 Person 模型实例的方法:

  • addHypothesis()
  • addHypotheses()
  • countHypotheses()
  • createHypothesis()
  • getHypotheses()
  • hasHypothesis()
  • hasHypotheses()
  • removeHypothesis()
  • removeHypotheses()
  • setHypotheses()

• 添加到假设模型实例的方法:

  • addPerson()
  • addPeople()
  • countPeople()
  • createPerson()
  • getPeople()
  • hasPerson()
  • hasPeople()
  • removePerson()
  • removePeople()
  • setPeople()

另一种毫无疑问的解决方法是检查 Sequelize 源代码本身，即 这里，我们可以在这里找到:

this.accessors = {get: 'get' + 复数,set: 'set' + 复数，addMultiple: 'add' + 复数，添加:'添加' + 单数，创建:'创建'+单数，删除:删除"+ 单数，removeMultiple: 'remove' + 复数，hasSingle: '有' + 单数，hasAll: '有' + 复数，计数:'计数' + 复数};

注意:虽然这可能看起来违反直觉，但实际上上面提到的两种方法 addPerson() 和 addPeople() 使用相同的参数，它们可以是单个值或数组.换句话说，源代码中的 add 和 addMultiple 方法实际上是相同的，最后.这同样适用于 remove() 和 removeMultiple()，以及 hasSingle() 和 hasAll().

希望您现在可以理解 Sequelize 文档对这些表格的真正含义.

如果您喜欢直接检查源代码，类似于我上面展示的，这些是其他类型关联的相关行:

• BelongsTo:这里

  this.accessors = {get: 'get' + 单数，set: 'set' + 单数，创建:'创建'+单数};

• HasOne:这里

  this.accessors = {get: 'get' + 单数，set: 'set' + 单数，创建:'创建'+单数};

• HasMany:这里

  this.accessors = {get: 'get' + 复数,set: 'set' + 复数，addMultiple: 'add' + 复数，添加:'添加' + 单数，创建:'创建'+单数，删除:删除"+ 单数，removeMultiple: 'remove' + 复数，hasSingle: '有' + 单数，hasAll: '有' + 复数，计数:'计数' + 复数};

While going through the sequelize docs, more specifically the documentations about associations, I see that the guide casually shows the reader methods such as setTasks(), addTask(), setProject(), that seem to be automatically created by sequelize for all model instances with respect to the created associations.

I couldn't find detailed information on what methods are available, and whether they are created with the singular version or plural version (since there is both setTasks() and setProject(), for example), and what exactly are the parameters they expect, and such. The docs apparently just casually mention them inside the examples...

So, what methods/mixins sequelize adds to the models when an association is made? And what are the parameters and return values, i.e. what's the documentation for those methods? Or, at least, where can I find them?

解决方案

The documentation about associations you linked, although hosted in an address called docs.sequelize.js, isn't the real sequelize docs (as in fully covered docs with all details that a good documentation usually provides). That is more like a tutorial / guide for starters.

The real sequelize docs are found by clicking on the "Reference" link available in the side menu of the links you mentioned (and it took me quite a while to find that - it doesn't even look like a clickable thing IMO).

The parts you're interested here are these:

• Sequelize docs for BelongsTo type of associations: here
• Sequelize docs for BelongsToMany type of associations: here
• Sequelize docs for HasMany type of associations: here
• Sequelize docs for HasOne type of associations: here

---

Understanding the docs

Since the docs linked above can be very confusing, here is an explanation to assist you to understand the docs.

Let's assume, for example, that we have a belongs to many association between Person and Hypothesis. Note that their plural forms, People and Hypotheses, are automatically inferred by Sequelize. This magic is done under the hood by the awesome library called inflection - see How do plurals work in Sequelize? for more details.

// Assuming that the models Person, Hypothesis and Person_Hypothesis are already defined
Person.belongsToMany(Hypothesis, { through: Person_Hypothesis });
Hypothesis.belongsToMany(Person, { through: Person_Hypothesis });

And we want to use the Sequelize docs for BelongsToMany type of associations to learn what methods were automatically added to instances of the Person and Hypothesis models. There, we can find the following table:

To understand what this table means, recall that in the beginning of that page of the docs it says that "In the API reference below, add the name of the association to the method". The most confusing part of this is that it's not so clear when you should add the singular version of the name and when you should add the plural version. But although the docs do not make this clear, I assure you that you can just use common sense to guess. And if you think both versions could make sense (for example, for add), be surprised that actually both versions are available. Therefore, from the table above, we can conclude:

• Methods added to instances of Person models:

  • addHypothesis()
  • addHypotheses()
  • countHypotheses()
  • createHypothesis()
  • getHypotheses()
  • hasHypothesis()
  • hasHypotheses()
  • removeHypothesis()
  • removeHypotheses()
  • setHypotheses()

• Methods added to instances of Hypothesis models:

  • addPerson()
  • addPeople()
  • countPeople()
  • createPerson()
  • getPeople()
  • hasPerson()
  • hasPeople()
  • removePerson()
  • removePeople()
  • setPeople()

Another way to figure this out without room for doubt is by checking the Sequelize source code itself, namely here, where we can find:

this.accessors = {
    get: 'get' + plural,
    set: 'set' + plural,
    addMultiple: 'add' + plural,
    add: 'add' + singular,
    create: 'create' + singular,
    remove: 'remove' + singular,
    removeMultiple: 'remove' + plural,
    hasSingle: 'has' + singular,
    hasAll: 'has' + plural,
    count: 'count' + plural
};

Note: although it might seem counter-intuitive, in fact both methods addPerson() and addPeople() mentioned above work with the same parameters, which can be either a single value or an array. In other words, the methods add and addMultiple from the source code are actually the same, in the end. The same applies to remove() and removeMultiple(), and hasSingle() and hasAll().

Hopefully with this you can now understand what the Sequelize docs really mean with those tables.

If you prefer to check the source code directly, analogously to what I showed above, these are the relevant lines for the other kinds of associations:

• BelongsTo: here

  this.accessors = {
      get: 'get' + singular,
      set: 'set' + singular,
      create: 'create' + singular
  };
  

• HasOne: here

  this.accessors = {
      get: 'get' + singular,
      set: 'set' + singular,
      create: 'create' + singular
  };
  

• HasMany: here

  this.accessors = {
      get: 'get' + plural,
      set: 'set' + plural,
      addMultiple: 'add' + plural,
      add: 'add' + singular,
      create: 'create' + singular,
      remove: 'remove' + singular,
      removeMultiple: 'remove' + plural,
      hasSingle: 'has' + singular,
      hasAll: 'has' + plural,
      count: 'count' + plural
  };
  

这篇关于建立关联时，哪些方法/mixin sequelize 添加到模型中?的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！