Add support for index / query hints in query builder

[uaoleg]

Q	A
Is bugfix?	❌
New feature?	✔️
Breaks BC?	❌
Fixed issues	#9119

[what-the-diff]

PR Summary

• Introduction of Force Index Property and Method
  The team has introduced a new attribute known as $forceIndex to the Query class and associated it with a new method forceIndex(). This method essentially allows setting the value of $forceIndex.

• Query Builder Updates
  In order to accommodate the new $forceIndex attribute, modifications were made to the buildFrom() function in the QueryBuilder file, thereby accepting $forceIndex as an additional parameter. This function was also updated to incorporate a new clause (FORCE INDEX) in our database queries whenever the $forceIndex parameter has a value. This encourages our system to apply specified index strategy while fetching data, helping in potential performance improvements.

[rob006]

Note that this syntax is planned to be deprecated in MySQL:

As of MySQL 8.0.20, the server supports the index-level optimizer hints JOIN_INDEX, GROUP_INDEX, ORDER_INDEX, and INDEX, which are equivalent to and intended to supersede FORCE INDEX index hints, as well as the NO_JOIN_INDEX, NO_GROUP_INDEX, NO_ORDER_INDEX, and NO_INDEX optimizer hints, which are equivalent to and intended to supersede IGNORE INDEX index hints. Thus, you should expect USE INDEX, FORCE INDEX, and IGNORE INDEX to be deprecated in a future release of MySQL, and at some time thereafter to be removed altogether.

These index-level optimizer hints are supported with both single-table and multi-table DELETE statements.

For more information, see Index-Level Optimizer Hints.

https://dev.mysql.com/doc/refman/8.0/en/index-hints.html

And new syntax can already be handled by $option parameter in select().

[rhertogh]

@uaoleg Looks good. Please also add unit tests and a line in the changelog.md

[rob006]

This is definitely not finished:

1. There are no tests that would verify that generated queries actually work.
2. Implementation uses MySQL specific syntax, so it would fail for the rest of DBMS.
3. This MySQL syntax is planned to be removed, so the only part of this PR that works, is already soft-deprecated.

IMO instead of providing API for FORCE INDEX clause, we should just provide API for adding something after table name (including table name for JOIN) - it should be easier to maintain and more flexible for users (even index hints for MySQL are more complicated than just FORCE INDEX). If you need index hints, you're probably targeting very specific DBMS with specific version, so having abstraction at framework level does not bring much benefit.

[codecov]

Codecov Report

Attention: Patch coverage is 60.00000% with 4 lines in your changes missing coverage. Please review.

Project coverage is 64.43%. Comparing base (47fb7fc) to head (f9d59c6).

Files with missing lines	Patch %	Lines
framework/db/Query.php	25.00%	3 Missing ⚠️
framework/db/QueryBuilder.php	83.33%	1 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##             master   #19946      +/-   ##
============================================
- Coverage     64.43%   64.43%   -0.01%     
- Complexity    11445    11447       +2     
============================================
  Files           433      433              
  Lines         37455    37462       +7     
============================================
+ Hits          24135    24138       +3     
- Misses        13320    13324       +4     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[xicond]

This is definitely not finished:

1. There are no tests that would verify that generated queries actually work.
2. Implementation uses MySQL specific syntax, so it would fail for the rest of DBMS.
3. This MySQL syntax is planned to be removed, so the only part of this PR that works, is already soft-deprecated.

IMO instead of providing API for FORCE INDEX clause, we should just provide API for adding something after table name (including table name for JOIN) - it should be easier to maintain and more flexible for users (even index hints for MySQL are more complicated than just FORCE INDEX). If you need index hints, you're probably targeting very specific DBMS with specific version, so having abstraction at framework level does not bring much benefit.

agree, it's same syntax in postgre sqlserver etc