Cyclic dependency checker should consider different 'as' parameter

[mlegenhausen]

I have following example:

var Sequelize = require('sequelize');
var sequelize = new Sequelize('sequelize-test', 'root', '');
var Content = sequelize.define('Content', {});
var Version = sequelize.define('Version', {});

Content.hasMany(Version);
Version.belongsTo(Content);

Content.belongsTo(Version, {
    as: 'ReleaseVersion',
    foreignKey: 'ReleaseVersionId'
});

Version.hasOne(Content, {
    as: 'ReleaseVersion',
    foreignKey: 'ReleaseVersionId'
});

sequelize.sync({ force: true });

Which produces following error:

Error: Cyclic dependency found. 'Contents' is dependent of itself.
Dependency Chain: Contents -> Versions => Contents

I want to associate the active release of a content by the Content model, for this I added a new association that links directly to my Version model. The key for this id (ReleaseVersionId) should be in the Content Table. This key can be null if no version was released. Since Version 2.0.0-dev11 I get an error when constructing something like this. Do I miss something or can I model something like this in a sequelize way?

[janmeier]

This is because dev11 introduces automatic foreign keys on your tables. This means that contentId on version will reference content.id, and content.realeaseVersionId will reference version.id. Since both tables now depend on each other, we cannot create any of them (content must be created before version, and version must be created before content.

To fix this problem, you should add constraints: false to the options of one or more of your associations to disable the foreign keys for these. If you want the security of foreign keys, you could add the keys manually after .sync has finished

[mlegenhausen]

Thanks for this super fast response time. That solved the problem.

[asimsohail]

@janmeier.. can you show how to manually add the keys after .sync is complete?

[janmeier]

@asimsohail Add them manually either using phpmyadmin/pgadmin whatever or by writing the query

[bottleofwater]

@janmeier Couldn't Sequelize first create the tables without the foreign keys, then add all the foreign keys right after?

[mickhansen]

@bottleofwater that could work

[Znarkus]

Is constraints: false and adding keys after .sync the canonical way of doing cyclic database structures?

Table structure:

template
- id
- category_id

category
- id
- default_template_id

[ralusek]

@mickhansen Is this currently in development?

[marc-ferrer]

I know this is an old issue, but why does not allowNull: true on the foreign key parameter make this work?

[jasonbodily]

Yes old issue, but it doesn't appear to work. With above, is this currently available?

EDIT: This does kind of work. You just have to do 3 things:

1. Add 'constraints: false' on one of the associations
2. Remove the relation information from the model attributes altogether
3. Write the custom migration that adds the fkey at the appropriate time. An example of that custom query is

queryInterface.sequelize.query('ALTER TABLE public."<source_table>"  ADD CONSTRAINT 
"<source_table>_<local_fkey>_fkey" FOREIGN KEY (<local_fkey>)  
REFERENCES public."<TargetTable>" (id) MATCH SIMPLE 
ON UPDATE NO ACTION ON DELETE NO ACTION')

[gzurbach]

@jasonbodily it's constraints: false (with an s)... spent a few minutes figuring that out :)

[jasonbodily]

@gzurbach - Sorry about that! Updated my answer!

[mentos1386]

@jasonbodily You have a typo, constrainst: false should be constraints: false (ts at the end`)

[petersg83]

Same problem here.
More than 2 years this issue has been opened :)
I'll add contraints: false but it hurts my heart :'(

[JQuezada0]

Was this ever resolved?

[xaiyeon]

Aw man and here I thought this was solved... Just ran into this issue, but I have over 15 tables with hasMany relationships :( I will try them without and query right after migration then, but how do I call a migration file to be executed after .sync().then((function{}))?

[semy]

Any news on this? :-(

[yocontra]

Can we get this issue reopened so somebody can potentially send a PR for this?

[yocontra]

@sushantdhiman Thanks!

[petrovi4]

@sushantdhiman Is this in development now?

[LFabre]

Any news?

[papb]

@LFabre and others - none that I know of. PR is welcome.

[esyeng]

Any news? :-(

[github-actions]

🎉 This issue has been resolved in version 6.20.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀

[ephys]

I'll close. Starting with Sequelize 6.20.0, if there is a cyclic foreign key, sync will first create the tables without foreign key constrants, then add them.
This change should resolve this issue.