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

feat(occ): add possibility to edit indices

1 files changed, 41 insertions, 0 deletions

diff --git a/lib/public/DB/Events/AddMissingIndicesEvent.php b/lib/public/DB/Events/AddMissingIndicesEvent.php
index dc942f3d63e..8b6d2a07a0c 100644
--- 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 @@ class AddMissingIndicesEvent extends \OCP\EventDispatcher\Event {
 	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;
+	}
 }