3 * Copyright (C) 2009-2023 SonarSource SA
4 * mailto:info AT sonarsource DOT com
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 3 of the License, or (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public License
17 * along with this program; if not, write to the Free Software Foundation,
18 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20 package org.sonar.server.platform.db.migration.step;
22 import java.sql.Connection;
23 import java.sql.SQLException;
24 import org.sonar.db.Database;
25 import org.sonar.db.DatabaseUtils;
26 import org.sonar.server.platform.db.migration.sql.CreateIndexBuilder;
28 public abstract class CreateIndexOnColumns extends DdlChange {
30 private final String table;
31 private final String indexPrefix;
32 private final String[] columnNames;
33 private final boolean unique;
35 protected CreateIndexOnColumns(Database db, String table, String indexPrefix, boolean unique, String... columnNames) {
38 this.indexPrefix = indexPrefix;
40 this.columnNames = columnNames;
44 public void execute(Context context) throws SQLException {
45 try (Connection connection = getDatabase().getDataSource().getConnection()) {
46 if (!DatabaseUtils.indexExistsIgnoreCase(table, newIndexName(), connection)) {
47 CreateIndexBuilder builder = new CreateIndexBuilder()
49 .setName(newIndexName())
51 for (String columnName : columnNames) {
52 builder.addColumn(columnName);
54 context.execute(builder.build());
59 public String newIndexName() {
60 return indexPrefix + "_" + String.join("_", columnNames);