Mixin Associations

    View code

    Creating associations in sequelize is done by calling one of the belongsTo / hasOne / hasMany / belongsToMany functions on a model (the source), and providing another model as the first argument to the function (the target).

    • hasOne - adds a foreign key to the target and singular association mixins to the source.
    • belongsTo - add a foreign key and singular association mixins to the source.
    • hasMany - adds a foreign key to target and plural association mixins to the source.
    • belongsToMany - creates an N:M association with a join table and adds plural association mixins to the source. The junction table is created with sourceId and targetId.

    Creating an association will add a foreign key constraint to the attributes. All associations use on update and SET NULL on delete, except for n:m, which also uses CASCADE on delete.

    When creating associations, you can provide an alias, via the as option. This is useful if the same model is associated twice, or you want your association to be called something other than the name of the target model.

    As an example, consider the case where users have many pictures, one of which is their profile picture. All pictures have a userId, but in addition the user model also has a profilePictureId, to be able to easily load the user's profile picture.

    To get full control over the foreign key column added by sequelize, you can use the foreignKey option. It can either be a string, that specifies the name, or and object type definition,equivalent to those passed to sequelize.define.

    1. User.hasMany(Picture, { foreignKey: 'uid' })

    The foreign key column in Picture will now be called uid instead of the default userId.

    1.   foreignKey: {
    2.     name: 'uid',
    3.     allowNull: false
    4.   }
    5. })

    This specifies that the uid column cannot be null. In most cases this will already be covered by the foreign key constraints, which sequelize creates automatically, but can be useful in case where the foreign keys are disabled, e.g. due to circular references (see constraints: false below).

    When fetching associated models, you can limit your query to only load some models. These queries are written in the same way as queries to find/findAll. To only get pictures in JPG, you can do:

    There are several ways to update and add new associations. Continuing with our example of users and pictures:

    1. user.addPicture(p) // Add a single picture
    3. user.addPictures([p1, p2]) // Associate user with these two pictures, but don't touch any current associations

    You don't have to pass in a complete object to the association functions, if your associated model has a single primary key:

    1. user.addPicture(req.query.pid) // Here pid is just an integer, representing the primary key of the picture

    Note how we also specified constraints: false for profile picture. This is because we add a foreign key from user to picture (profilePictureId), and from picture to user (userId). If we were to add foreign keys to both, it would create a cyclic dependency, and sequelize would not know which table to create first, since user depends on picture, and picture depends on user. These kinds of problems are detected by sequelize before the models are synced to the database, and you will get an error along the lines of Error: Cyclic dependency found. 'users' is dependent of itself. If you encounter this, you should either disable some constraints, or rethink your associations completely.

    View code

    Creates an association between this (the source) and the provided target. The foreign key is added on the target.

    Example: User.hasOne(Profile). This will add userId to the profile table.

    Params:

    View code

    Creates an association between this (the source) and the provided target. The foreign key is added on the source.

    Example: Profile.belongsTo(User). This will add userId to the profile table.

    Params:

    Creates a 1:m association between this (the source) and the provided target. The foreign key is added on the target.

    Example: User.hasMany(Profile). This will add userId to the profile table.

    Params:

    Create an N:M association with a join table.

    Defining through is required. Sequelize would previously attempt to auto generate names but that would not always lead to the most logical setups.

    If you define a through model with custom attributes, these attributes can be set when adding / setting new associations in two ways. Consider users and projects from before with a join table that stores whether the project has been started yet:

    1.   started: Sequelize.BOOLEAN
    2. })
    3. User.belongsToMany(Project, { through: UserProjects })
    4. Project.belongsToMany(User, { through: UserProjects })
    1. jan.addProject(homework, { started: false }) // The homework project is not started yet
    2. jan.setProjects([makedinner, doshopping], { started: true}) // Both shopping and dinner has been started

    If you want to set several target instances, but with different attributes you have to set the attributes on the instance, using a property with the name of the through model:

    Similarly, when fetching through a join table with custom attributes, these attributes will be available as an object with the name of the through model.

    1. user.getProjects().then(function (projects) {
    2.   var p1 = projects[0]
    3.   p1.UserProjects.started // Is this project started yet?

    This document is automatically generated based on source code comments. Please do not edit it directly, as your changes will be ignored. Please write on IRC, open an issue or a create a pull request if you feel something can be improved. For help on how to write source code documentation see and dox