RelationshipCache - Add case_id column

[colemanw]

Overview

This makes it possible to show case relationships in SearchKit.

Before

Cannot filter relationships by case.

After

Can show relationships for specific cases.

Technical Details

This adds a mirror column to the relationship_cache table, since SearchKit can't do the complex joins that would be needed without the field present. SearchKit doesn't support the relationship table, it always uses RelationshipCache per #17781, therefore any data we need from relationships needs to be in the cache table.

While I was at it I also added the Component tag to the column in both tables, so it is only present when CiviCase is enabled.

[civibot]

(Standard links)

• If this is your first pull-request for CiviCRM, please browse CONTRIBUTING.md for information about the development and testing processes.
• If you are reviewing this pull-request, you may wish to consult the test sites and the Review Standards (long template, short template).

[demeritcowboy]

added the Component tag to the column in both tables, so it is only present when CiviCase is enabled

I'm not sure what the tag does fully but I assume the above means "only present IN SEARCH KIT UI when CiviCase is enabled".

Otherwise I ran the upgrade and clicked around a bit and it seems ok. I did notice a minor separate thing but I'll make a lab ticket.

For the upgrade I started thinking about the fact that WHERE case_id IS NOT NULL will do a full table scan but I think I've convinced myself it's not worth trying to out-think mysql and the clause is better for sites that don't use civicase.

[colemanw]

added the Component tag to the column in both tables, so it is only present when CiviCase is enabled

I'm not sure what the tag does fully

@demeritcowboy it means the column is only visible to APIv4 when the component is enabled. If tests are happy with it then I think it's a safe addition.

[seamuslee001]

@colemanw on upgrade your just adding the column not the FK but on install it would have an additional FK right based on the xml?

[colemanw]

Ugh, how do we even do that?

[demeritcowboy]

civicrm-core/CRM/Upgrade/Incremental/php/FiveForty.php

Line 93 in 09e790b

if (!self::checkFKExists('civicrm_contribution_product', 'FK_civicrm_contribution_product_product_id')) {

[demeritcowboy]

Good catch @seamuslee001.

[colemanw]

Thanks @seamuslee001 and @demeritcowboy, I think I got the FK added correctly now.

[demeritcowboy]

Thanks works ok for me.

KEY FK_civicrm_relationship_cache_case_id (case_id),
CONSTRAINT FK_civicrm_relationship_cache_case_id FOREIGN KEY (case_id) REFERENCES civicrm_case (id) ON DELETE CASCADE,

I also checked that this doesn't prevent creating a regular relationship where case_id is null since I couldn't remember how that worked with foreign keys.

And interestingly the UPDATE would still do a table scan even if you switch the addition of the foreign key to come before the UPDATE. The foreign key adds an implicit index, so I was thinking it might improve it but it's not clear it does. What I mean is EXPLAIN without the index says "Using where". With it it says "Using where; using index".

[colemanw]

Merge-on-pass?