Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve performance of financial ACL where clause #31976

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

dontub
Copy link

@dontub dontub commented Feb 6, 2025

Overview

This replaces the NOT IN check with a NOT EXISTS check in the financial ACL where clause. This massively improves the performance. Before it was more or less unusable with many records.

Technical Details

The implementation results in a clause like this:

`a`.`id` AND NOT EXISTS (SELECT 1 FROM civicrm_line_item WHERE contribution_id = `a`.`id` AND financial_type_id IN (1,2,3,4)

The first `a`.`id` is obviously superfluous, but doesn't really hurt. With $clauses[''][] = 'AND NOT EXISTS ... the result would be an invalid clause: `a`.`` AND NOT EXISTS ...

Edit: The call of

$formattedClause = CRM_Utils_SQL::prefixFieldNames($fieldClause, array_keys($fields), $bao->tableName());

in \CRM_Utils_SQL::mergeSubquery() always resulted in $fieldClause === $formattedClause because $fieldClause is passed as reference. Thus, this had to be fixed, too, because of this calls:

$clauses['contribution_id'] = CRM_Utils_SQL::mergeSubquery('Contribution');

$clauses['contribution_id'] = CRM_Utils_SQL::mergeSubquery('Contribution');

Copy link

civibot bot commented Feb 6, 2025

🤖 Thank you for contributing to CiviCRM! ❤️ We will need to test and review this PR. 👷

Introduction for new contributors...
  • If this is your first PR, an admin will greenlight automated testing with the command ok to test or add to whitelist.
  • A series of tests will automatically run. You can see the results at the bottom of this page (if there are any problems, it will include a link to see what went wrong).
  • A demo site will be built where anyone can try out a version of CiviCRM that includes your changes.
  • If this process needs to be repeated, an admin will issue the command test this please to rerun tests and build a new demo site.
  • Before this PR can be merged, it needs to be reviewed. Please keep in mind that reviewers are volunteers, and their response time can vary from a few hours to a few weeks depending on their availability and their knowledge of this particular part of CiviCRM.
  • A great way to speed up this process is to "trade reviews" with someone - find an open PR that you feel able to review, and leave a comment like "I'm reviewing this now, could you please review mine?" (include a link to yours). You don't have to wait for a response to get started (and you don't have to stop at one!) the more you review, the faster this process goes for everyone 😄
  • To ensure that you are credited properly in the final release notes, please add yourself to contributor-key.yml
  • For more information about contributing, see CONTRIBUTING.md.
Quick links for reviewers...

➡️ Online demo of this PR 🔗

@civibot civibot bot added the master label Feb 6, 2025
Dominic Tubach added 3 commits February 10, 2025 17:16
The first argument of `CRM_Utils_SQL::prefixFieldNames()` is passed as
reference so previously `$fieldClause === $formattedClause` was always
true.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants