Add index on operationTime column of generic_data_index_queue table (#121)

Author: markus-moser

config/doctrine_migrations.yaml

@@ -0,0 +1,3 @@
+doctrine_migrations:
+  migrations_paths:
+    'Pimcore\Bundle\GenericDataIndexBundle\Migrations': '@PimcoreGenericDataIndexBundle/src/Migrations'

qodana.yaml

@@ -39,6 +39,9 @@ exclude:
   - name: PhpUnusedParameterInspection
     paths:
         - src/SearchIndexAdapter/OpenSearch/Search/Modifier
+  - name: PhpMethodNamingConventionInspection
+    paths:
+        - src/Migrations
 include:
   - name: PhpTaintFunctionInspection
   - name: PhpVulnerablePathsInspection

src/DependencyInjection/PimcoreGenericDataIndexExtension.php

@@ -21,6 +21,7 @@
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Extension\PrependExtensionInterface;
 use Symfony\Component\DependencyInjection\Loader;
+use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
 use Symfony\Component\HttpKernel\DependencyInjection\Extension;
 use Symfony\Component\Yaml\Exception\ParseException;
 use Symfony\Component\Yaml\Yaml;
@@ -52,8 +53,20 @@ public function load(array $configs, ContainerBuilder $container): void
         $this->registerIndexServiceParams($container, $config['index_service']);
     }
 
+    /**
+     * @throws Exception
+     */
     public function prepend(ContainerBuilder $container): void
     {
+        if ($container->hasExtension('doctrine_migrations')) {
+            $loader = new YamlFileLoader(
+                $container,
+                new FileLocator(__DIR__ . '/../../config')
+            );
+
+            $loader->load('doctrine_migrations.yaml');
+        }
+
         $filename = __DIR__ . '/../../config/doctrine.yaml';
 
         try {

src/Entity/IndexQueue.php

@@ -19,6 +19,7 @@
 #[Entity]
 #[ORM\Table(name: self::TABLE)]
 #[ORM\Index(columns: ['dispatched'], name: self::TABLE . '_dispatched')]
+#[ORM\Index(columns: ['operationTime'], name: self::TABLE . '_operation_time')]
 
 /**
  * @internal

src/Installer.php

@@ -21,6 +21,7 @@
 use Doctrine\DBAL\Schema\SchemaException;
 use Pimcore;
 use Pimcore\Bundle\GenericDataIndexBundle\Entity\IndexQueue;
+use Pimcore\Bundle\GenericDataIndexBundle\Migrations\Version20240325081139;
 use Pimcore\Extension\Bundle\Installer\Exception\InstallationException;
 use Symfony\Component\HttpKernel\Bundle\BundleInterface;
 
@@ -37,6 +38,11 @@ public function __construct(
         parent::__construct($bundle);
     }
 
+    public function getLastMigrationVersionClassName(): ?string
+    {
+        return Version20240325081139::class;
+    }
+
     /**
      * @throws SchemaException|Exception
      */
@@ -96,6 +102,7 @@ private function installIndexQueueTable(Schema $schema): void
 
             $queueTable->setPrimaryKey(['elementId', 'elementType']);
             $queueTable->addIndex(['dispatched'], IndexQueue::TABLE . '_dispatched');
+            $queueTable->addIndex(['operationTime'], IndexQueue::TABLE . '_operation_time');
         }
     }
 

src/Migrations/Version20240325081139.php

@@ -0,0 +1,51 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * Pimcore
+ *
+ * This source file is available under following license:
+ * - Pimcore Commercial License (PCL)
+ *
+ *  @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
+ *  @license    http://www.pimcore.org/license     PCL
+ */
+
+namespace Pimcore\Bundle\GenericDataIndexBundle\Migrations;
+
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\Migrations\AbstractMigration;
+use Pimcore\Bundle\GenericDataIndexBundle\Entity\IndexQueue;
+
+/**
+ * Auto-generated Migration: Please modify to your needs!
+ */
+final class Version20240325081139 extends AbstractMigration
+{
+    public function getDescription(): string
+    {
+        return 'Add index on operationTime column in generic_data_index_queue table';
+    }
+
+    public function up(Schema $schema): void
+    {
+        $indexName = IndexQueue::TABLE . '_operation_time';
+        if (!$schema->getTable(IndexQueue::TABLE)->hasIndex($indexName)) {
+            $this->addSql('ALTER TABLE `' . IndexQueue::TABLE . '`
+                ADD INDEX `' . $indexName . '` (`operationTime`)
+            ;');
+        }
+    }
+
+    public function down(Schema $schema): void
+    {
+        $indexName = IndexQueue::TABLE . '_operation_time';
+        if ($schema->getTable(IndexQueue::TABLE)->hasIndex($indexName)) {
+            $this->addSql('ALTER TABLE `' . IndexQueue::TABLE . '`
+                DROP INDEX `' . $indexName . '`
+            ;');
+        }
+
+    }
+}