docs: clarify how the limit option works

[ephys]

Pull Request Checklist

• Have you added new tests to prevent regressions?
• Does npm run test or npm run 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

I'm attempting to clarify what FindOptions#limit does and its interaction with FindOptions#subQuery

Related to #9605

[WikiRik]

Looks good. Just to check; do we have tests for these three examples to ensure that's the actual behavior?

[ephys]

We test for limit + include here: https://github.com/sequelize/sequelize/blob/main/test/unit/sql/select.test.js#L281
However we never test limit + include + subQuery: false. But we do it: https://github.com/sequelize/sequelize/blob/main/lib/dialects/abstract/query-generator.js#L1164

There is also an undocumented groupedLimit option, I'm not sure of what it does.
I found this on groupedLimit: #6560

[ephys]

I've removed the third example I added as it's an unrelated limit option (Includable.limit) with a different behavior.

I've also piggybacked this tiny PR to document a weirdness I found in operators.ts (registering operators in the global symbol registry).

[WikiRik]

However we never test limit + include + subQuery: false. But we do it: https://github.com/sequelize/sequelize/blob/main/lib/dialects/abstract/query-generator.js#L1164

Could you add tests for this?

[ephys]

Sounds good, I'll look into it :)

[ephys]

Test added

[WikiRik]

Woops, was too early with the approval. Do fix the mssql assertion first

[ephys]

That's weird. Why does mssql produce
ORDER BY [user].[last_name] ASC, [user].[id_user]
instead of
ORDER BY [user].[last_name] ASC

it doesn't seem to be doing that in other queries or when subQuery is true

Ok so MssqlQueryGenerator#addLimitAndOffset returns , [user].[id_user] OFFSET 10 ROWS FETCH NEXT 30 ROWS ONLY which looks like a hack to me

[ephys]

Ok it should be fixed

[WikiRik]

Looks good, any idea if/when you want to address those TODOs?

[ephys]

Not in this PR but we'll eventually get to it as we migrate to TS

[github-actions]

🎉 This PR is included in version 7.0.0-alpha.6 🎉

The release is available on:

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

Your semantic-release bot 📦🚀