feat: added support for index include

[lohart13]

Pull Request Checklist

Please make sure to review and check all of these items:

• Have you added new tests to prevent regressions?
• Does yarn test or yarn test-DIALECT pass with this change (including linting)?
• Is a documentation update included (if this change modifies existing APIs, or introduces new ones)?
• Did you update the typescript typings accordingly (if applicable)?
• Does the description below contain a link to an existing issue (Closes #[issue]) or a description of the issue you are solving?
• Did you follow the commit message conventions explained in CONTRIBUTING.md?

Description Of Change

This pull requests adds the ability to support indexes with included columns for MSSQL.
For information on how this works and the benefits, please see Microsoft documentation of this feature.

Fixes #15124

[WikiRik]

Will need to do a more in-depth review later, but these are my initial comments

[lohart13]

@WikiRik looking at the test, do you want this to exist under the dialects > mssql folder?
It appears that db2 and postgres can support index with include (in specific versions) therefore not exactly mssql specific.

• https://www.postgresql.org/docs/current/sql-createindex.html
• https://www.ibm.com/docs/en/db2/11.1?topic=statements-create-index

[WikiRik]

I guess you can include the tests after the following;

sequelize/test/integration/model.test.js

Line 612 in 79a5300

});

But I might prefer a separate test file test/integration/index.test.js since model.test.js already has quite some tests

[lohart13]

But I might prefer a separate test file test/integration/index.test.js since model.test.js already has quite some tests

I've updated the test location now.
Let me know if you have any further questions

[WikiRik]

Can you enable the support for db2 and postgres in this PR as well?

[lohart13]

@WikiRik I've added support now, however there are some conditions for postgres and db2.

For postgres, the include option for indexes is only supported in version 11 and above therefore this would not be supported for all the versions of postgres that sequelize currently support.

For db2, the include option for indexes is only available for unique indexes.

I've added in some errors and tests to make sure that these limitations are enforced.

Let me know if you have any questions/suggestions

[WikiRik]

Thanks! I think we're dropping support for postgres 10 in v7 as well since the final release of that will come out on November 10th so let's wait with merging this PR until we do so. That makes the implementation easier.

Pinging @ephys @sdepold as well to confirm dropping postgres 10 support as soon as postgres itself does it

[ephys]

We can drop postgres 10 in v7

[WikiRik]

I've created a PR to drop the postgres 10 support; it's #15289. Once that has been merged, this PR can be updated accordingly

[lohart13]

I've removed the postgres db version checks now.
LMK if there are any further changes required

[ephys]

This looks like really good work! Thank you :)

[WikiRik]

These comments are redundant since the error is clear. But it's a non-blocking issue.
Thanks for working on this!

[krzysztofw-hippo]

Hi, any idea when this will be released? I don't see it in v6.26.0, will it be included in v6.26.1?
Many thanks

[WikiRik]

This will land in the next v7 alpha, there are no plans from the maintainers to backport this to v6 but we're always open to PRs from the community

[lohart13]

Tagging PR to sequelize/website#501