source.dussan.org Git - sonarqube.git/blob

   1 /*
   2  * SonarQube
   3  * Copyright (C) 2009-2023 SonarSource SA
   4  * mailto:info AT sonarsource DOT com
   5  *
   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.
  10  *
  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.
  15  *
  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.
  19  */
  20 package org.sonar.server.platform.db.migration.sql;
  21
  22 import java.util.ArrayList;
  23 import java.util.List;
  24 import org.sonar.server.platform.db.migration.def.ColumnDef;
  25
  26 import static com.google.common.base.Preconditions.checkArgument;
  27 import static java.util.Collections.singletonList;
  28 import static java.util.Objects.requireNonNull;
  29 import static org.sonar.server.platform.db.migration.def.Validations.validateIndexName;
  30 import static org.sonar.server.platform.db.migration.def.Validations.validateTableName;
  31
  32 public class CreateIndexBuilder {
  33
  34   private final List<String> columns = new ArrayList<>();
  35   private String tableName;
  36   private String indexName;
  37   private boolean unique = false;
  38
  39   /**
  40    * Required name of table on which index is created
  41    */
  42   public CreateIndexBuilder setTable(String s) {
  43     this.tableName = s;
  44     return this;
  45   }
  46
  47   /**
  48    * Required name of index. Name must be unique among all the tables
  49    * of the schema.
  50    */
  51   public CreateIndexBuilder setName(String s) {
  52     this.indexName = s;
  53     return this;
  54   }
  55
  56   /**
  57    * By default index is NOT UNIQUE (value {@code false}).
  58    */
  59   public CreateIndexBuilder setUnique(boolean b) {
  60     this.unique = b;
  61     return this;
  62   }
  63
  64   /**
  65    * Add a column to the scope of index. Order of calls to this
  66    * method is important and is kept as-is when creating the index.
  67    * The attribute used from {@link ColumnDef} is the name.
  68    * Other attributes are ignored.
  69    */
  70   public CreateIndexBuilder addColumn(ColumnDef column) {
  71     columns.add(requireNonNull(column, "Column cannot be null").getName());
  72     return this;
  73   }
  74
  75   /**
  76    * Add a column to the scope of index. Order of calls to this
  77    * method is important and is kept as-is when creating the index.
  78    */
  79   public CreateIndexBuilder addColumn(String column) {
  80     columns.add(requireNonNull(column, "Column cannot be null"));
  81     return this;
  82   }
  83
  84   public List<String> build() {
  85     validateTableName(tableName);
  86     validateIndexName(indexName);
  87     checkArgument(!columns.isEmpty(), "at least one column must be specified");
  88     return singletonList(createSqlStatement());
  89   }
  90
  91   private String createSqlStatement() {
  92     StringBuilder sql = new StringBuilder("CREATE ");
  93     if (unique) {
  94       sql.append("UNIQUE ");
  95     }
  96     sql.append("INDEX ");
  97     sql.append(indexName);
  98     sql.append(" ON ");
  99     sql.append(tableName);
 100     sql.append(" (");
 101     sql.append(String.join(", ", columns));
 102     sql.append(")");
 103     return sql.toString();
 104   }
 105 }