Api4 - Support entities in alternate databases

Author: colemanw

Civi/Api4/Entity.php

@@ -65,6 +65,10 @@ class Entity extends Generic\AbstractEntity {
       'name' => 'table_name',
       'description' => 'Name of sql table, if applicable',
     ],
+    [
+      'name' => 'database_name',
+      'description' => 'Name of sql database, if different from CiviCRM',
+    ],
     [
       'name' => 'primary_key',
       'data_type' => 'Array',

Civi/Api4/Query/Api4SelectQuery.php

@@ -77,8 +77,8 @@ public function __construct($api) {
       $this->addSpecField($field['name'], $field);
     }
 
-    $tableName = CoreUtil::getTableName($this->getEntity());
-    $this->query = \CRM_Utils_SQL_Select::from($tableName . ' ' . self::MAIN_TABLE_ALIAS);
+    $tableExpr = CoreUtil::getTableExpr($this->getEntity());
+    $this->query = \CRM_Utils_SQL_Select::from($tableExpr . ' ' . self::MAIN_TABLE_ALIAS);
 
     $this->fillEntityValues();
 
@@ -486,7 +486,8 @@ private function addExplicitJoins() {
         $this->addSpecField($alias . '.' . $field['name'], $field);
       }
       $tableName = CoreUtil::getTableName($entity);
-      $this->startNewJoin($tableName, $alias);
+      $tableExpr = CoreUtil::getTableExpr($entity);
+      $this->startNewJoin($tableExpr, $alias);
       // Save join info to be retrieved by $this->getExplicitJoin()
       $joinOn = array_filter(array_filter($join, 'is_array'));
       $this->explicitJoins[$alias] = [
@@ -601,8 +602,9 @@ protected function addBridgeJoin($joinTree, $joinEntity, $alias) {
 
     $bridgeAlias = $alias . '_via_' . strtolower($bridgeEntity);
 
-    $joinTable = CoreUtil::getTableName($joinEntity);
-    [$bridgeTable, $baseRef, $joinRef] = $this->getBridgeRefs($bridgeEntity, $joinEntity);
+    $joinTableExpr = CoreUtil::getTableExpr($joinEntity);
+    $bridgeTableExpr = CoreUtil::getTableExpr($bridgeEntity);
+    [$baseRef, $joinRef] = $this->getBridgeRefs($bridgeEntity, $joinEntity);
 
     $this->registerBridgeJoinFields($bridgeEntity, $joinRef, $baseRef, $alias, $bridgeAlias);
 
@@ -630,12 +632,12 @@ protected function addBridgeJoin($joinTree, $joinEntity, $alias) {
     // Info needed for joining custom fields extending the bridge entity
     $this->explicitJoins[$alias]['bridge_table_alias'] = $bridgeAlias;
     // Invert the join so all nested joins will link to the bridge entity
-    $this->openJoin['table'] = $bridgeTable;
+    $this->openJoin['table'] = $bridgeTableExpr;
     $this->openJoin['alias'] = $bridgeAlias;
 
     // Add main table as inner join
     $innerConditions = array_merge($linkConditions, $acls);
-    $this->addJoin('INNER', $joinTable, $alias, $bridgeAlias, $innerConditions);
+    $this->addJoin('INNER', $joinTableExpr, $alias, $bridgeAlias, $innerConditions);
     return array_merge($outerConditions, $bridgeConditions);
   }
 
@@ -652,7 +654,6 @@ private function getBridgeRefs(string $bridgeEntity, string $joinEntity): array
     /** @var \CRM_Core_DAO $bridgeDAO */
     $bridgeDAO = CoreUtil::getInfoItem($bridgeEntity, 'dao');
     $bridgeEntityFields = \Civi\API\Request::create($bridgeEntity, 'get', ['version' => 4, 'checkPermissions' => $this->getCheckPermissions()])->entityFields();
-    $bridgeTable = $bridgeDAO::getTableName();
 
     // Get the 2 bridge reference columns as CRM_Core_Reference_* objects
     $referenceColumns = $bridgeDAO::getReferenceColumns();
@@ -664,7 +665,7 @@ private function getBridgeRefs(string $bridgeEntity, string $joinEntity): array
         }
         foreach ($bridgeDAO::getReferenceColumns() as $baseRef) {
           if ($baseRef->getReferenceKey() === $bridges[$refKey]['to']) {
-            return [$bridgeTable, $baseRef, $joinRef];
+            return [$baseRef, $joinRef];
           }
         }
       }
@@ -887,43 +888,43 @@ protected function autoJoinFK($key) {
   /**
    * Begins a new join; as long as it's "open" then additional joins will nest inside it.
    */
-  private function startNewJoin(string $tableName, string $joinAlias): void {
+  private function startNewJoin(string $tableExpr, string $joinAlias): void {
     $this->openJoin = [
-      'table' => $tableName,
+      'table' => $tableExpr,
       'alias' => $joinAlias,
       'subjoins' => [],
     ];
   }
 
   private function finishJoin(string $side, $conditions): void {
     $tableAlias = $this->openJoin['alias'];
-    $tableName = $this->openJoin['table'];
+    $tableExpr = $this->openJoin['table'];
     $subjoinClause = '';
     foreach ($this->openJoin['subjoins'] as $subjoin) {
-      $subjoinClause .= " INNER JOIN `{$subjoin['table']}` `{$subjoin['alias']}` ON (" . implode(' AND ', $subjoin['conditions']) . ")";
+      $subjoinClause .= " INNER JOIN {$subjoin['table']} `{$subjoin['alias']}` ON (" . implode(' AND ', $subjoin['conditions']) . ")";
     }
-    $this->query->join($tableAlias, "$side JOIN (`$tableName` `$tableAlias`$subjoinClause) ON " . implode(' AND ', $conditions));
+    $this->query->join($tableAlias, "$side JOIN ($tableExpr `$tableAlias`$subjoinClause) ON " . implode(' AND ', $conditions));
     $this->openJoin = NULL;
   }
 
   /**
    * @param string $side
-   * @param string $tableName
+   * @param string $tableExpr
    * @param string $tableAlias
    * @param string $baseTableAlias
    * @param array $conditions
    */
-  private function addJoin(string $side, string $tableName, string $tableAlias, string $baseTableAlias, array $conditions): void {
+  private function addJoin(string $side, string $tableExpr, string $tableAlias, string $baseTableAlias, array $conditions): void {
     // If this join is based off the current open join, incorporate it
     if ($baseTableAlias === ($this->openJoin['alias'] ?? NULL)) {
       $this->openJoin['subjoins'][] = [
-        'table' => $tableName,
+        'table' => $tableExpr,
         'alias' => $tableAlias,
         'conditions' => $conditions,
       ];
     }
     else {
-      $this->query->join($tableAlias, "$side JOIN `$tableName` `$tableAlias` ON " . implode(' AND ', $conditions));
+      $this->query->join($tableAlias, "$side JOIN $tableExpr `$tableAlias` ON " . implode(' AND ', $conditions));
     }
   }
 

Civi/Api4/Utils/CoreUtil.php

@@ -135,6 +135,22 @@ public static function getTableName(string $entityName): ?string {
     return self::getInfoItem($entityName, 'table_name');
   }
 
+  /**
+   * Get sql for table, including database prefix if needed
+   *
+   * @param string $entityName
+   *
+   * @return string|null
+   */
+  public static function getTableExpr(string $entityName): ?string {
+    $tableName = self::getInfoItem($entityName, 'table_name');
+    $databaseName = self::getInfoItem($entityName, 'database_name');
+    if ($databaseName) {
+      return "`$databaseName`.`$tableName`";
+    }
+    return "`$tableName`";
+  }
+
   /**
    * Given a sql table name, return the name of the api entity.
    *

tests/phpunit/api/v4/Query/Api4SelectQueryTest.php

@@ -67,7 +67,7 @@ public function testAggregateNoGroupBy(): void {
     $query = new Api4SelectQuery($api);
     $this->assertEquals(
       'SELECT SUM(`a`.`amount`) AS `SUM_amount`
-FROM civicrm_pledge a',
+FROM `civicrm_pledge` a',
       trim($query->getSql())
     );
   }