website icon indicating copy to clipboard operation
website copied to clipboard

List of things that need to be added to the documentation

Open ephys opened this issue 4 years ago • 5 comments

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.on https://github.com/sequelize/sequelize/issues/5385#issuecomment-324479607
  • [ ] Document Preliminary support for include.through.where https://github.com/sequelize/sequelize/commit/4887b84030caedb4d85d71c2afe9030954dd374a#diff-52a8641b8c0175da7b47275f77edce69
  • [ ] In raw queries, document that arrays ([1,2,3]) are inlined as 1,2,3, not postgres arrays. Document how to handle the empty array ([])

Eager-loading

  • [ ] Document how to customize the ON clause of joins (using https://sequelize.org/api/v7/interfaces/includeoptions#on)

Migrations

  • [ ] Emphasize that sync is unsafe in production
  • [x] Document how to use raw SQL (sequelize.query)
  • [ ] Document how to use .sql migration files
  • [ ] Document queryInterface

v7 breaking changes

  • [ ] https://github.com/sequelize/sequelize/pull/17560

DataTypes

  • [ ] https://github.com/sequelize/sequelize/pull/15565

ephys avatar Apr 15 '22 21:04 ephys

Can I use this issue to list mine? If it is invalid you can remove it :)

fzn0x avatar Oct 15 '22 14:10 fzn0x

I'd say edit your first comment in this thread to add a list there :)

ephys avatar Oct 15 '22 14:10 ephys

Thanks!

fzn0x avatar Oct 15 '22 14:10 fzn0x

  • [ ] Document the format of the URI option that can be passed to the Sequelize constructor

Hornwitser avatar Aug 27 '23 12:08 Hornwitser