Improved JavaDoc

flyway · Oct 18, 2018 · 2a5a01e · 2a5a01e
1 parent 278cbd0
commit 2a5a01e
Show file tree

Hide file tree

Showing 8 changed files with 42 additions and 11 deletions.
diff --git a/flyway-commandline/src/main/assembly/flyway.conf b/flyway-commandline/src/main/assembly/flyway.conf
@@ -58,11 +58,13 @@ flyway.url=
 # flyway.initSql=
 
 # Comma-separated list of schemas managed by Flyway. These schema names are case-sensitive.
-# (default: The default schema for the datasource connection)
 # Consequences:
+# - Flyway will automatically attempt to create all these schemas, unless the first one already exists.
 # - The first schema in the list will be automatically set as the default one during the migration.
 # - The first schema in the list will also be the one containing the schema history table.
 # - The schemas will be cleaned in the order of this list.
+# - If Flyway created them, the schemas themselves will as be dropped when cleaning.
+# (default: The default schema for the database connection)
 # flyway.schemas=
 
 # Name of Flyway's schema history table (default: flyway_schema_history)

diff --git a/flyway-core/src/main/java/org/flywaydb/core/Flyway.java b/flyway-core/src/main/java/org/flywaydb/core/Flyway.java
@@ -841,12 +841,14 @@ public void setEncoding(String encoding) {
     }
 
     /**
-     * Sets the schemas managed by Flyway. These schema names are case-sensitive. (default: The default schema for the datasource connection)
+     * Sets the schemas managed by Flyway. These schema names are case-sensitive. (default: The default schema for the database connection)
      * <p>Consequences:</p>
      * <ul>
+     * <li>Flyway will automatically attempt to create all these schemas, unless the first one already exists.</li>
      * <li>The first schema in the list will be automatically set as the default one during the migration.</li>
      * <li>The first schema in the list will also be the one containing the schema history table.</li>
      * <li>The schemas will be cleaned in the order of this list.</li>
+     * <li>If Flyway created them, the schemas themselves will as be dropped when cleaning.</li>
      * </ul>
      *
      * @param schemas The schemas managed by Flyway. May not be {@code null}. Must contain at least one element.

diff --git a/flyway-core/src/main/java/org/flywaydb/core/api/configuration/ClassicConfiguration.java b/flyway-core/src/main/java/org/flywaydb/core/api/configuration/ClassicConfiguration.java
@@ -102,12 +102,14 @@ public class ClassicConfiguration implements Configuration {
     private Charset encoding = Charset.forName("UTF-8");
 
     /**
-     * The schemas managed by Flyway.  These schema names are case-sensitive. (default: The default schema for the datasource connection)
+     * The schemas managed by Flyway. These schema names are case-sensitive.
      * <p>Consequences:</p>
      * <ul>
+     * <li>Flyway will automatically attempt to create all these schemas, unless the first one already exists.</li>
      * <li>The first schema in the list will be automatically set as the default one during the migration.</li>
      * <li>The first schema in the list will also be the one containing the schema history table.</li>
      * <li>The schemas will be cleaned in the order of this list.</li>
+     * <li>If Flyway created them, the schemas themselves will as be dropped when cleaning.</li>
      * </ul>
      */
     private String[] schemaNames = {};
@@ -977,12 +979,14 @@ public void setEncodingAsString(String encoding) {
     }
 
     /**
-     * Sets the schemas managed by Flyway. These schema names are case-sensitive. (default: The default schema for the datasource connection)
+     * Sets the schemas managed by Flyway. These schema names are case-sensitive. (default: The default schema for the database connection)
      * <p>Consequences:</p>
      * <ul>
+     * <li>Flyway will automatically attempt to create all these schemas, unless the first one already exists.</li>
      * <li>The first schema in the list will be automatically set as the default one during the migration.</li>
      * <li>The first schema in the list will also be the one containing the schema history table.</li>
      * <li>The schemas will be cleaned in the order of this list.</li>
+     * <li>If Flyway created them, the schemas themselves will as be dropped when cleaning.</li>
      * </ul>
      *
      * @param schemas The schemas managed by Flyway. May not be {@code null}. Must contain at least one element.

diff --git a/flyway-core/src/main/java/org/flywaydb/core/api/configuration/Configuration.java b/flyway-core/src/main/java/org/flywaydb/core/api/configuration/Configuration.java
@@ -200,15 +200,17 @@ public interface Configuration {
     String getTable();
 
     /**
-     * Retrieves the schemas managed by Flyway.  These schema names are case-sensitive.
+     * Retrieves the schemas managed by Flyway. These schema names are case-sensitive.
      * <p>Consequences:</p>
      * <ul>
+     * <li>Flyway will automatically attempt to create all these schemas, unless the first one already exists.</li>
      * <li>The first schema in the list will be automatically set as the default one during the migration.</li>
      * <li>The first schema in the list will also be the one containing the schema history table.</li>
      * <li>The schemas will be cleaned in the order of this list.</li>
+     * <li>If Flyway created them, the schemas themselves will as be dropped when cleaning.</li>
      * </ul>
      *
-     * @return The schemas managed by Flyway. (default: The default schema for the datasource connection)
+     * @return The schemas managed by Flyway. (default: The default schema for the database connection)
      */
     String[] getSchemas();
 

diff --git a/flyway-core/src/main/java/org/flywaydb/core/api/configuration/FluentConfiguration.java b/flyway-core/src/main/java/org/flywaydb/core/api/configuration/FluentConfiguration.java
@@ -559,12 +559,14 @@ public FluentConfiguration encoding(Charset encoding) {
     }
 
     /**
-     * Sets the schemas managed by Flyway. These schema names are case-sensitive. (default: The default schema for the datasource connection)
+     * Sets the schemas managed by Flyway. These schema names are case-sensitive. (default: The default schema for the database connection)
      * <p>Consequences:</p>
      * <ul>
+     * <li>Flyway will automatically attempt to create all these schemas, unless the first one already exists.</li>
      * <li>The first schema in the list will be automatically set as the default one during the migration.</li>
      * <li>The first schema in the list will also be the one containing the schema history table.</li>
      * <li>The schemas will be cleaned in the order of this list.</li>
+     * <li>If Flyway created them, the schemas themselves will as be dropped when cleaning.</li>
      * </ul>
      *
      * @param schemas The schemas managed by Flyway. May not be {@code null}. Must contain at least one element.

diff --git a/flyway-gradle-plugin/src/main/java/org/flywaydb/gradle/FlywayExtension.java b/flyway-gradle-plugin/src/main/java/org/flywaydb/gradle/FlywayExtension.java
@@ -67,7 +67,16 @@ public class FlywayExtension {
     public String table;
 
     /**
-     * The case-sensitive list of schemas managed by Flyway
+     * The schemas managed by Flyway. These schema names are case-sensitive. (default: The default schema for the database connection)
+     * <p>Consequences:</p>
+     * <ul>
+     * <li>Flyway will automatically attempt to create all these schemas, unless the first one already exists.</li>
+     * <li>The first schema in the list will be automatically set as the default one during the migration.</li>
+     * <li>The first schema in the list will also be the one containing the schema history table.</li>
+     * <li>The schemas will be cleaned in the order of this list.</li>
+     * <li>If Flyway created them, the schemas themselves will as be dropped when cleaning.</li>
+     * </ul>
+     * <p>Also configurable with Gradle or System Property: ${flyway.schemas} (comma-separated list)</p>
      */
     public String[] schemas;
 

diff --git a/flyway-gradle-plugin/src/main/java/org/flywaydb/gradle/task/AbstractFlywayTask.java b/flyway-gradle-plugin/src/main/java/org/flywaydb/gradle/task/AbstractFlywayTask.java
@@ -108,7 +108,16 @@ public abstract class AbstractFlywayTask extends DefaultTask {
     public String table;
 
     /**
-     * The case-sensitive list of schemas managed by Flyway
+     * The schemas managed by Flyway. These schema names are case-sensitive. (default: The default schema for the database connection)
+     * <p>Consequences:</p>
+     * <ul>
+     * <li>Flyway will automatically attempt to create all these schemas, unless the first one already exists.</li>
+     * <li>The first schema in the list will be automatically set as the default one during the migration.</li>
+     * <li>The first schema in the list will also be the one containing the schema history table.</li>
+     * <li>The schemas will be cleaned in the order of this list.</li>
+     * <li>If Flyway created them, the schemas themselves will as be dropped when cleaning.</li>
+     * </ul>
+     * <p>Also configurable with Gradle or System Property: ${flyway.schemas} (comma-separated list)</p>
      */
     public String[] schemas;
 

diff --git a/flyway-maven-plugin/src/main/java/org/flywaydb/maven/AbstractFlywayMojo.java b/flyway-maven-plugin/src/main/java/org/flywaydb/maven/AbstractFlywayMojo.java
@@ -116,13 +116,14 @@ abstract class AbstractFlywayMojo extends AbstractMojo {
     private String initSql;
 
     /**
-     * List of the schemas managed by Flyway. These schema names are case-sensitive.<br/>
-     * (default: The default schema for the datasource connection)
+     * The schemas managed by Flyway. These schema names are case-sensitive. (default: The default schema for the database connection)
      * <p>Consequences:</p>
      * <ul>
+     * <li>Flyway will automatically attempt to create all these schemas, unless the first one already exists.</li>
      * <li>The first schema in the list will be automatically set as the default one during the migration.</li>
      * <li>The first schema in the list will also be the one containing the schema history table.</li>
      * <li>The schemas will be cleaned in the order of this list.</li>
+     * <li>If Flyway created them, the schemas themselves will as be dropped when cleaning.</li>
      * </ul>
      * <p>Also configurable with Maven or System Property: ${flyway.schemas} (comma-separated list)</p>
      */