Creating with Associations

An instance can be created with nested association in one step, provided all elements are new.

In contrast, performing updates and deletions involving nested objects is currently not possible. For that, you will have to perform each separate action explicitly.

BelongsTo / HasMany / HasOne association

Consider the following models:

  1. class Product extends Model {}
  2. Product.init({
  3.   title: Sequelize.STRING
  4. }, { sequelize, modelName: 'product' });
  5. class User extends Model {}
  6. User.init({
  7.   firstName: Sequelize.STRING,
  8.   lastName: Sequelize.STRING
  9. }, { sequelize, modelName: 'user' });
  10. class Address extends Model {}
  11. Address.init({
  12.   type: DataTypes.STRING,
  13.   line1: Sequelize.STRING,
  14.   line2: Sequelize.STRING,
  15.   city: Sequelize.STRING,
  16.   state: Sequelize.STRING,
  17.   zip: Sequelize.STRING,
  18. }, { sequelize, modelName: 'address' });
  20. // We save the return values of the association setup calls to use them later
  21. Product.User = Product.belongsTo(User);
  22. User.Addresses = User.hasMany(Address);
  23. // Also works for `hasOne`

A new Product, User, and one or more Address can be created in one step in the following way:

  1. return Product.create({
  2.   title: 'Chair',
  3.   user: {
  4.     firstName: 'Mick',
  5.     lastName: 'Broadstone',
  6.     addresses: [{
  7.       type: 'home',
  8.       line1: '100 Main St.',
  9.       city: 'Austin',
  10.       state: 'TX',
  11.       zip: '78704'
  12.     }]
  13.   }
  14. }, {
  15.   include: [{
  16.     association: Product.User,
  17.     include: [ User.Addresses ]
  18.   }]
  19. });

Observe the usage of the include option in the Product.create call. That is necessary for Sequelize to understand what you are trying to create along with the association.

Note: here, our user model is called user, with a lowercase u - This means that the property in the object should also be user. If the name given to sequelize.define was User, the key in the object should also be User. Likewise for addresses, except it’s pluralized being a hasMany association.

BelongsTo association with an alias

The previous example can be extended to support an association alias.

  1. const Creator = Product.belongsTo(User, { as: 'creator' });
  3. return Product.create({
  4.   title: 'Chair',
  5.   creator: {
  6.     firstName: 'Matt',
  7.     lastName: 'Hansen'
  8.   }
  9. }, {
  10.   include: [ Creator ]
  11. });

HasMany / BelongsToMany association

Let’s introduce the ability to associate a product with many tags. Setting up the models could look like:

  1. class Tag extends Model {}
  2. Tag.init({
  3.   name: Sequelize.STRING
  4. }, { sequelize, modelName: 'tag' });
  6. Product.hasMany(Tag);
  7. // Also works for `belongsToMany`.

Now we can create a product with multiple tags in the following way:

  1. Product.create({
  2.   id: 1,
  3.   title: 'Chair',
  4.   tags: [
  5.     { name: 'Alpha'},
  6.     { name: 'Beta'}
  7.   ]
  8. }, {
  9.   include: [ Tag ]
  10. })

And, we can modify this example to support an alias as well:

  1. const Categories = Product.hasMany(Tag, { as: 'categories' });
  3. Product.create({
  4.   id: 1,
  5.   title: 'Chair',
  6.   categories: [
  7.     { id: 1, name: 'Alpha' },
  8.     { id: 2, name: 'Beta' }
  9.   ]
  10. }, {
  11.   include: [{
  12.     association: Categories,
  13.     as: 'categories'
  14.   }]
  15. })