Merge pull request #43209 from nextcloud/enh/edit-indices

feat(occ): add possibility to edit indices
nextcloud · Feb 28, 2024 · b2751b5 · b2751b5
2 parents 0f9f244 + 06d0764
commit b2751b5
Show file tree

Hide file tree

Showing 2 changed files with 92 additions and 5 deletions.
diff --git a/core/Command/Db/AddMissingIndices.php b/core/Command/Db/AddMissingIndices.php
@@ -73,7 +73,9 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 		$this->dispatcher->dispatchTyped($event);
 
 		$missingIndices = $event->getMissingIndices();
-		if ($missingIndices !== []) {
+		$toReplaceIndices = $event->getIndicesToReplace();
+
+		if ($missingIndices !== [] || $toReplaceIndices !== []) {
 			$schema = new SchemaWrapper($this->connection);
 
 			foreach ($missingIndices as $missingIndex) {
@@ -97,15 +99,59 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 							$table->addIndex($missingIndex['columns'], $missingIndex['indexName'], [], $missingIndex['options']);
 						}
 
-
-						$sqlQueries = $this->connection->migrateToSchema($schema->getWrappedSchema(), $dryRun);
-						if ($dryRun && $sqlQueries !== null) {
-							$output->writeln($sqlQueries);
+						if (!$dryRun) {
+							$this->connection->migrateToSchema($schema->getWrappedSchema());
 						}
 						$output->writeln('<info>' . $table->getName() . ' table updated successfully.</info>');
 					}
 				}
 			}
+
+			foreach ($toReplaceIndices as $toReplaceIndex) {
+				if ($schema->hasTable($toReplaceIndex['tableName'])) {
+					$table = $schema->getTable($toReplaceIndex['tableName']);
+
+					$allOldIndicesExists = true;
+					foreach ($toReplaceIndex['oldIndexNames'] as $oldIndexName) {
+						if (!$table->hasIndex($oldIndexName)) {
+							$allOldIndicesExists = false;
+						}
+					}
+
+					if (!$allOldIndicesExists) {
+						continue;
+					}
+
+					$output->writeln('<info>Adding additional ' . $toReplaceIndex['newIndexName'] . ' index to the ' . $table->getName() . ' table, this can take some time...</info>');
+
+					if ($toReplaceIndex['uniqueIndex']) {
+						$table->addUniqueIndex($toReplaceIndex['columns'], $toReplaceIndex['newIndexName'], $toReplaceIndex['options']);
+					} else {
+						$table->addIndex($toReplaceIndex['columns'], $toReplaceIndex['newIndexName'], [], $toReplaceIndex['options']);
+					}
+
+					if (!$dryRun) {
+						$this->connection->migrateToSchema($schema->getWrappedSchema());
+					}
+
+					foreach ($toReplaceIndex['oldIndexNames'] as $oldIndexName) {
+						$output->writeln('<info>Removing ' . $oldIndexName . ' index from the ' . $table->getName() . ' table</info>');
+						$table->dropIndex($oldIndexName);
+					}
+
+					if (!$dryRun) {
+						$this->connection->migrateToSchema($schema->getWrappedSchema());
+					}
+					$output->writeln('<info>' . $table->getName() . ' table updated successfully.</info>');
+				}
+			}
+
+			if ($dryRun) {
+				$sqlQueries = $this->connection->migrateToSchema($schema->getWrappedSchema(), $dryRun);
+				if ($sqlQueries !== null) {
+					$output->writeln($sqlQueries);
+				}
+			}
 		}
 
 		return 0;

diff --git a/lib/public/DB/Events/AddMissingIndicesEvent.php b/lib/public/DB/Events/AddMissingIndicesEvent.php
@@ -39,6 +39,9 @@ class AddMissingIndicesEvent extends \OCP\EventDispatcher\Event {
 	/** @var array<array-key, array{tableName: string, indexName: string, columns: string[], options: array{}, dropUnnamedIndex: bool, uniqueIndex: bool}> */
 	private array $missingIndices = [];
 
+	/** @var array<array-key, array{tableName: string, oldIndexNames: array, newIndexName: string, columns: string[], uniqueIndex: bool, options: array{}}> */
+	private array $toReplaceIndices = [];
+
 	/**
 	 * @param string[] $columns
 	 * @since 28.0.0
@@ -75,4 +78,42 @@ public function addMissingUniqueIndex(string $tableName, string $indexName, arra
 	public function getMissingIndices(): array {
 		return $this->missingIndices;
 	}
+
+	/**
+	 * Replace one or more existing indices with a new one. Can be used to make an index unique afterwards or merge two indices into a multicolumn index.
+	 *
+	 * Note: Make sure to not use the same index name for the new index as for old indices.
+	 *
+	 * Example:
+	 *
+	 * <code>
+	 *     $event->replaceIndex(
+	 *         'my_table',
+	 *         ['old_index_col_a', 'old_index_col_b'],
+	 *         'new_index_col_a_b',
+	 *         ['column_a', 'column_b'],
+	 *         false
+	 *     );
+	 * </code>
+	 *
+	 * @since 29.0.0
+	 */
+	public function replaceIndex(string $tableName, array $oldIndexNames, string $newIndexName, array $columns, bool $unique, array $options = []): void {
+		$this->toReplaceIndices[] = [
+			'tableName' => $tableName,
+			'oldIndexNames' => $oldIndexNames,
+			'newIndexName' => $newIndexName,
+			'columns' => $columns,
+			'uniqueIndex' => $unique,
+			'options' => $options,
+		];
+	}
+
+	/**
+	 * @since 29.0.0
+	 * @return array<array-key, array{tableName: string, oldIndexNames: array, newIndexName: string, columns: string[], uniqueIndex: bool, options: array{}}>
+	 */
+	public function getIndicesToReplace(): array {
+		return $this->toReplaceIndices;
+	}
 }