website
website copied to clipboard
List of things that need to be added to the documentation
Instead of creating many issues, I'll keep a list of things we should add to the documentation here:
Associations
- [ ] Document how foreign key names are generated. See https://github.com/sequelize/sequelize/issues/5828#issuecomment-1062689739
- [ ] Document
include.onhttps://github.com/sequelize/sequelize/issues/5385#issuecomment-324479607 - [ ] Document
Preliminary support for include.through.wherehttps://github.com/sequelize/sequelize/commit/4887b84030caedb4d85d71c2afe9030954dd374a#diff-52a8641b8c0175da7b47275f77edce69 - [ ] In raw queries, document that arrays (
[1,2,3]) are inlined as1,2,3, not postgres arrays. Document how to handle the empty array ([])
Eager-loading
- [ ] Document how to customize the
ONclause of joins (using https://sequelize.org/api/v7/interfaces/includeoptions#on)
Migrations
- [ ] Emphasize that
syncis unsafe in production - [x] Document how to use raw SQL (
sequelize.query) - [ ] Document how to use
.sqlmigration files - [ ] Document
queryInterface
v7 breaking changes
- [ ] https://github.com/sequelize/sequelize/pull/17560
DataTypes
- [ ] https://github.com/sequelize/sequelize/pull/15565
Can I use this issue to list mine? If it is invalid you can remove it :)
I'd say edit your first comment in this thread to add a list there :)
Thanks!
- [ ] Document the format of the URI option that can be passed to the
Sequelizeconstructor