-modify KDoc for checkExcessiveIndices and make it public again

-modify KDoc for checkExcessiveForeignKeyConstraints and make it public
JetBrains · Jan 24, 2024 · 5c5dcb0 · 5c5dcb0
1 parent 89319da
commit 5c5dcb0
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 6 deletions.
diff --git a/exposed-core/api/exposed-core.api b/exposed-core/api/exposed-core.api
@@ -1846,6 +1846,8 @@ public final class org/jetbrains/exposed/sql/SchemaUtils {
 	public final fun addMissingColumnsStatements ([Lorg/jetbrains/exposed/sql/Table;Z)Ljava/util/List;
 	public static synthetic fun addMissingColumnsStatements$default (Lorg/jetbrains/exposed/sql/SchemaUtils;[Lorg/jetbrains/exposed/sql/Table;ZILjava/lang/Object;)Ljava/util/List;
 	public final fun checkCycle ([Lorg/jetbrains/exposed/sql/Table;)Z
+	public final fun checkExcessiveForeignKeyConstraints ([Lorg/jetbrains/exposed/sql/Table;Z)Ljava/util/List;
+	public final fun checkExcessiveIndices ([Lorg/jetbrains/exposed/sql/Table;Z)Ljava/util/List;
 	public final fun checkMappingConsistence ([Lorg/jetbrains/exposed/sql/Table;Z)Ljava/util/List;
 	public static synthetic fun checkMappingConsistence$default (Lorg/jetbrains/exposed/sql/SchemaUtils;[Lorg/jetbrains/exposed/sql/Table;ZILjava/lang/Object;)Ljava/util/List;
 	public final fun create ([Lorg/jetbrains/exposed/sql/Table;Z)V

diff --git a/exposed-core/src/main/kotlin/org/jetbrains/exposed/sql/SchemaUtils.kt b/exposed-core/src/main/kotlin/org/jetbrains/exposed/sql/SchemaUtils.kt
@@ -531,12 +531,13 @@ object SchemaUtils {
     }
 
     /**
-     * Checks all [tables] for any that have more than one defined index and logs the findings.
+     * Checks all [tables] for any that have more than one defined index and logs the findings. If found, this function
+     * also logs the SQL statements that can be used to drop these indices.
      *
-     * If found, this function also logs and returns the SQL statements that can be used to drop these constraints.
+     * @return List of indices that are excessive and can be dropped.
      */
     @Suppress("NestedBlockDepth")
-    private fun checkExcessiveIndices(vararg tables: Table, withLogs: Boolean): List<Index> {
+    fun checkExcessiveIndices(vararg tables: Table, withLogs: Boolean): List<Index> {
         val toDrop = HashSet<Index>()
 
         val excessiveIndices =
@@ -570,12 +571,13 @@ object SchemaUtils {
     }
 
     /**
-     * Checks all [tables] for any that have more than one defined foreign key constraint and logs the findings.
+     * Checks all [tables] for any that have more than one defined foreign key constraint and logs the findings. If
+     * found, this function also logs the SQL statements that can be used to drop these foreign key constraints.
      *
-     * If found, this function also logs and returns the SQL statements that can be used to drop these constraints.
+     * @return List of foreign key constraints that are excessive and can be dropped.
      */
     @Suppress("NestedBlockDepth")
-    private fun checkExcessiveForeignKeyConstraints(vararg tables: Table, withLogs: Boolean): List<ForeignKeyConstraint> {
+    fun checkExcessiveForeignKeyConstraints(vararg tables: Table, withLogs: Boolean): List<ForeignKeyConstraint> {
         val toDrop = HashSet<ForeignKeyConstraint>()
 
         val excessiveConstraints = currentDialect.columnConstraints(*tables).filter { (_, fkConstraints) -> fkConstraints.size > 1 }