Api4 - Support entities in alternate databases

[colemanw]

Overview

Allows Api4 entities to exist in different sql databases from CiviCRM.

Technical Details

To use this, add the following to an Api4 entity file:

  public static function getInfo():array {
    $info = parent::getInfo();
    if ($entityIsInAnotherDatabase) {
      $info['database_name'] = 'name_of_other_db';
    }
    return $info;
  }

[civibot]

🤖 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...

• ➡️ PR Demo site (can be rebuilt with the command test this please).
• 📖 Review standards
• 🗒️ Review template (brief or verbose)

➡️ Online demo of this PR 🔗

[eileenmcnaughton]

I think we have been doing this by including the database in the table name

[colemanw]

@eileenmcnaughton who has been doing it?
Since existing code adds backticks around the table name, you'd have to get cleverly hackish and call the table something like "my_alt_database`.`my_other_table"

[colemanw]

@braders to test this patch, add a function like this to your non-civi api4 entity:

  public static function getInfo():array {
    $info = parent::getInfo();
    if (wp is in a separate database) {
      $info['database_name'] = 'name_of_wp_db';
    }
    return $info;
  }

[braders]

@colemanw I've given this a test, and it seems to work really well 👍. I'll have a think over the next day or so if I can think of any scenarios this doesn't cover, but so far so good.

[eileenmcnaughton]

@colemanw Ah I see - we installed a view & used that as our table - so Civi is not aware it is looking in a different DB

[seamuslee001]

Flagging as merge ready given @braders 's feedback