dev/core#2575 remove / improve indexes

This removes a couple of indexes on the id field as they duplicate the primary key
as pointed out in https://lab.civicrm.org/dev/core/-/issues/2575

In addition a couple of other indexes are removed as duplicates but the
originals are fixed to be more meaningful. It's important that in a combined
key the field with the lowest cardinality is the first as the combined key is
searched for a complete match so on something like line_item we see the
key is

civicrm_contribution1
civicrm_contribution10
civicrm_contribution1111
civicrm_membership1

In this case there are only 3 possible variants for the first chunk of
characters so we get a much more effective key by reversing them.
(arguably the entity_table actually adds no value due to it's low
cardinality).

The original post
https://civicrm.stackexchange.com/questions/39409/redundant-indexes
also suggests that

is_deleted_sort_name_id duplicates the id index

That is not the case - this query would only ever be
used if is_deleted is a filter. If it IS used then the id
index would NOT be used as only one index is used per table.

However, note that the id part of the filter would only be used if
is_deleted and sort_name were too - so the id part is of little value
as the last parameter & it's likely mysql would chose to use the
primary key instead.

However, I would argue the index as a whole is of little value. The
cardinality of is_deleted is super low and so preceding sort_name
with it is probably inferior to just leaving the
sort_name index to be used. However, this would need testing on
a site with enough data to get results.

On the queue index - it's hard to imagine that having more than the
queue name in the index adds any value at all. However, this is also such a small
table that probably the index has almost no size and the query probably takes
almost no time to run so the time we would spend testing index changes on
this table we would likely never get back.

Note changing these indexes will only affect new sites - or existing sites if they
run the System.updateIndexes api. We do have a ticket open
https://lab.civicrm.org/dev/core/-/issues/2279 with a proposal to
allow sites to define their own indexes which would work in conjunction with the
above api call (since indexes are not 1 size fits all - for example we
have removed indexes on things like contribution_status_id due to
low cardinality). We don't pro-actively run index updates on upgrade
due to not wanting to alter custom index config until 2279 is resolved
and also because some old DBs hit issues that we never diagnosed (and stopped
trying to once we stopped pro-actively notifying them about them)

diff --git a/CRM/Core/DAO/EntityFile.php b/CRM/Core/DAO/EntityFile.php
index 9b5240bfe95ba0b88ce6d700c0f28bb21e729951..d26286a44b80d7a7f296c1861bb02039e9b97de2 100644 (file)
--- a/CRM/Core/DAO/EntityFile.php
+++ b/CRM/Core/DAO/EntityFile.php
@@ -6,7 +6,7 @@
  *
  * Generated from xml/schema/CRM/Core/EntityFile.xml
  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
- * (GenCodeChecksum:76720cd19bd7b5bbbf1461184198acc5)
+ * (GenCodeChecksum:37cc0051ec4b2d54eeeefe4c4d004b6d)
  */
 
 /**
@@ -231,25 +231,16 @@ class CRM_Core_DAO_EntityFile extends CRM_Core_DAO {
    */
   public static function indices($localize = TRUE) {
     $indices = [
-      'index_entity' => [
-        'name' => 'index_entity',
+      'UI_entity_id_entity_table_file_id' => [
+        'name' => 'UI_entity_id_entity_table_file_id',
         'field' => [
-          0 => 'entity_table',
-          1 => 'entity_id',
-        ],
-        'localizable' => FALSE,
-        'sig' => 'civicrm_entity_file::0::entity_table::entity_id',
-      ],
-      'UI_entity_table_entity_id_file_id' => [
-        'name' => 'UI_entity_table_entity_id_file_id',
-        'field' => [
-          0 => 'entity_table',
-          1 => 'entity_id',
+          0 => 'entity_id',
+          1 => 'entity_table',
           2 => 'file_id',
         ],
         'localizable' => FALSE,
         'unique' => TRUE,
-        'sig' => 'civicrm_entity_file::1::entity_table::entity_id::file_id',
+        'sig' => 'civicrm_entity_file::1::entity_id::entity_table::file_id',
       ],
     ];
     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;

diff --git a/CRM/Financial/DAO/FinancialType.php b/CRM/Financial/DAO/FinancialType.php
index 8a54a2047808d511522bae4399cbf4b5992b9343..a5db19a8dc7dff990a2a4845edcd75e0e704fd00 100644 (file)
--- a/CRM/Financial/DAO/FinancialType.php
+++ b/CRM/Financial/DAO/FinancialType.php
@@ -6,7 +6,7 @@
  *
  * Generated from xml/schema/CRM/Financial/FinancialType.xml
  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
- * (GenCodeChecksum:4f25c751d874b9438009c8685f8d6843)
+ * (GenCodeChecksum:035576414ddb721b2607522dc5d874e4)
  */
 
 /**
@@ -287,17 +287,7 @@ class CRM_Financial_DAO_FinancialType extends CRM_Core_DAO {
    * @return array
    */
   public static function indices($localize = TRUE) {
-    $indices = [
-      'UI_id' => [
-        'name' => 'UI_id',
-        'field' => [
-          0 => 'id',
-        ],
-        'localizable' => FALSE,
-        'unique' => TRUE,
-        'sig' => 'civicrm_financial_type::1::id',
-      ],
-    ];
+    $indices = [];
     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
   }
 

diff --git a/CRM/Price/DAO/LineItem.php b/CRM/Price/DAO/LineItem.php
index 4649837b1c377aca5185b3c7ed8ed257e951c286..c226921b4b59325318f6b8991a7f57141e7068ae 100644 (file)
--- a/CRM/Price/DAO/LineItem.php
+++ b/CRM/Price/DAO/LineItem.php
@@ -6,7 +6,7 @@
  *
  * Generated from xml/schema/CRM/Price/LineItem.xml
  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
- * (GenCodeChecksum:ce105cf63ee265d470ed263f959a7706)
+ * (GenCodeChecksum:1c10b6b406bb73014b2fbe6ceb95fda3)
  */
 
 /**
@@ -511,27 +511,18 @@ class CRM_Price_DAO_LineItem extends CRM_Core_DAO {
    */
   public static function indices($localize = TRUE) {
     $indices = [
-      'index_entity' => [
-        'name' => 'index_entity',
-        'field' => [
-          0 => 'entity_table',
-          1 => 'entity_id',
-        ],
-        'localizable' => FALSE,
-        'sig' => 'civicrm_line_item::0::entity_table::entity_id',
-      ],
       'UI_line_item_value' => [
         'name' => 'UI_line_item_value',
         'field' => [
-          0 => 'entity_table',
-          1 => 'entity_id',
+          0 => 'entity_id',
+          1 => 'entity_table',
           2 => 'contribution_id',
           3 => 'price_field_value_id',
           4 => 'price_field_id',
         ],
         'localizable' => FALSE,
         'unique' => TRUE,
-        'sig' => 'civicrm_line_item::1::entity_table::entity_id::contribution_id::price_field_value_id::price_field_id',
+        'sig' => 'civicrm_line_item::1::entity_id::entity_table::contribution_id::price_field_value_id::price_field_id',
       ],
     ];
     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;

diff --git a/xml/schema/Core/EntityFile.xml b/xml/schema/Core/EntityFile.xml
index 37ac0882c10146bc1f482dfe190c30c011dc526c..e2dc7bbd6b5c31072a2730b41a5d47a2d76148db 100644 (file)
--- a/xml/schema/Core/EntityFile.xml
+++ b/xml/schema/Core/EntityFile.xml
@@ -43,12 +43,6 @@
     <typeColumn>entity_table</typeColumn>
     <add>1.5</add>
   </dynamicForeignKey>
-  <index>
-    <name>index_entity</name>
-    <fieldName>entity_table</fieldName>
-    <fieldName>entity_id</fieldName>
-    <add>1.5</add>
-  </index>
   <field>
     <name>file_id</name>
     <title>File ID</title>
@@ -67,9 +61,9 @@
     <add>1.5</add>
   </foreignKey>
   <index>
-    <name>UI_entity_table_entity_id_file_id</name>
-    <fieldName>entity_table</fieldName>
+    <name>UI_entity_id_entity_table_file_id</name>
     <fieldName>entity_id</fieldName>
+    <fieldName>entity_table</fieldName>
     <fieldName>file_id</fieldName>
     <unique>true</unique>
     <add>1.1</add>

diff --git a/xml/schema/Financial/FinancialType.xml b/xml/schema/Financial/FinancialType.xml
index c6850f15cea41f752491cbe1c11510db9b34b29c..cc158141b0f0efd3f18608e7f79aa89e5c4846d8 100644 (file)
--- a/xml/schema/Financial/FinancialType.xml
+++ b/xml/schema/Financial/FinancialType.xml
@@ -97,10 +97,4 @@
       <label>Enabled?</label>
     </html>
   </field>
-  <index>
-    <name>UI_id</name>
-    <fieldName>id</fieldName>
-    <unique>true</unique>
-    <add>4.3</add>
-  </index>
 </table>

diff --git a/xml/schema/Price/LineItem.xml b/xml/schema/Price/LineItem.xml
index 98b7e38e78063982e8975bdcdc2469509a48b620..6b2733e7174e98e9ce04ba7e71ab4b6ee2d3a51e 100644 (file)
--- a/xml/schema/Price/LineItem.xml
+++ b/xml/schema/Price/LineItem.xml
@@ -138,16 +138,10 @@
     <add>3.2</add>
 
   </field>
-  <index>
-    <name>index_entity</name>
-    <fieldName>entity_table</fieldName>
-    <fieldName>entity_id</fieldName>
-    <add>1.7</add>
-  </index>
-  <index>
+   <index>
     <name>UI_line_item_value</name>
-    <fieldName>entity_table</fieldName>
     <fieldName>entity_id</fieldName>
+    <fieldName>entity_table</fieldName>
     <fieldName>contribution_id</fieldName>
     <fieldName>price_field_value_id</fieldName>
     <fieldName>price_field_id</fieldName>