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.es;
  21
  22 import java.util.Map;
  23 import java.util.Set;
  24
  25 public interface MigrationEsClient {
  26
  27   /**
  28    * This method is re-entrant and does not fail if indexName or otherIndexNames do not exist
  29    */
  30   void deleteIndexes(String name, String... otherNames);
  31
  32   /**
  33    * Adds a new mapping to an existing Elasticsearch index. Does nothing if index does not exist.
  34    *
  35    * @param index name of the index that the mapping is added to
  36    * @param type document type in the index
  37    * @param mappingName name of the new mapping
  38    * @param mappingType type of the new mapping
  39    * @param options additional options to be applied to the mapping
  40    */
  41   void addMappingToExistingIndex(String index, String type, String mappingName, String mappingType, Map<String, String> options);
  42
  43   /**
  44    * Returns the indices that have been touched by {@link #addMappingToExistingIndex(String, String, String, String, Map)}
  45    */
  46   Set<String> getUpdatedIndices();
  47 }