Added notes for flyway/flyway#2120

_includes/cfg/oracleSqlplusWarn.html

@@ -0,0 +1 @@
+{% include cfg/_cfg.html name="oracle.sqlplusWarn" pro=true required=false default="false" description='Whether Flyway should issue a warning instead of an error whenever it encounters an Oracle SQL*Plus statement it doesn't yet support.' %}

documentation/commandline/migrate.md

@@ -329,6 +329,7 @@ Migrates the schema to the latest version. Flyway will create the schema history
             Omit to use the default mode of executing the SQL statements directly against the database.</td>
     </tr>
     {% include cfg/oracleSqlplus.html %}
+    {% include cfg/oracleSqlplusWarn.html %}
     {% include cfg/licenseKey.html %}
     </tbody>
 </table>
@@ -378,6 +379,7 @@ flyway.installedBy=my-user
 flyway.errorOverrides=99999:17110:E,42001:42001:W
 flyway.dryRunOutput=/my/sql/dryrun-outputfile.sql
 flyway.oracle.sqlplus=true
+flyway.oracle.sqlplusWarn=true
 ```
 
 ## Sample output

documentation/commandline/undo.md

@@ -244,6 +244,7 @@ subtitle: 'Command-line: undo'
             Omit to use the default mode of executing the SQL statements directly against the database.</td>
     </tr>
     {% include cfg/oracleSqlplus.html %}
+    {% include cfg/oracleSqlplusWarn.html %}
     {% include cfg/licenseKey.html %}
     </tbody>
 </table>
@@ -284,6 +285,8 @@ flyway.ignoreFutureMigrations=false
 flyway.installedBy=my-user
 flyway.errorOverrides=99999:17110:E,42001:42001:W
 flyway.dryRunOutput=/my/sql/dryrun-outputfile.sql
+flyway.oracle.sqlplus=true
+flyway.oracle.sqlplusWarn=true
 ```
 
 ## Sample output

documentation/commandline/validate.md

@@ -242,6 +242,8 @@ Validation fails if
             warning is logged and Flyway continues normally. This is useful for situations where one must be able to redeploy
             an older version of the application after the database has been migrated by a newer one.</td>
     </tr>
+    {% include cfg/oracleSqlplus.html %}
+    {% include cfg/oracleSqlplusWarn.html %}
     {% include cfg/licenseKey.html %}
     </tbody>
 </table>
@@ -280,6 +282,8 @@ flyway.ignoreMissingMigrations=false
 flyway.ignoreIgnoredMigrations=false
 flyway.ignorePendingMigrations=false
 flyway.ignoreFutureMigrations=false
+flyway.oracle.sqlplus=true
+flyway.oracle.sqlplusWarn=true
 ```
 
 ## Sample output

documentation/configfiles.md

@@ -71,11 +71,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)
@@ -85,6 +87,11 @@ flyway.url=
 # schema of the list.
 # flyway.table=
 
+# The tablespace where to create the schema history table that will be used by Flyway.
+# This setting is only relevant for databases that do support the notion of tablespaces. It's value is simply
+# ignored for all others. (default: The default tablespace for the database connection)
+# flyway.tablespace=
+
 # Comma-separated list of locations to scan recursively for migrations. (default: filesystem:<<INSTALL-DIR>>/sql)
 # The location type is determined by its prefix.
 # Unprefixed locations or locations starting with classpath: point to a package on the classpath and may contain
@@ -263,13 +270,23 @@ flyway.url=
 # <<blank>> for the current database user of the connection. (default: <<blank>>).
 # flyway.installedBy=
 
-# Rules for the built-in error handling that lets you override specific SQL states and errors codes from error to
-# warning or from warning to error.
-# Each error override has the following format: STATE:12345:W. It is a 5 character SQL state, a colon, the SQL
-# error code, a colon and finally the desired behavior that should override the initial one. The following
-# behaviors are accepted: W to force a warning and E to force an error.
-# For example, to force Oracle stored procedure compilation issues to produce errors instead of warnings,
-# the following errorOverride can be used: 99999:17110:E
+# Rules for the built-in error handler that let you override specific SQL states and errors codes in order to
+# force specific errors or warnings to be treated as debug messages, info messages, warnings or errors.
+# Each error override has the following format: STATE:12345:W. It is a 5 character SQL state, a colon, the
+# SQL error code, a colon and finally the desired behavior that should override the initial one.
+# The following behaviors are accepted:
+# - D to force a debug message
+# - D- to force a debug message, but do not show the original sql state and error code
+# - I to force an info message
+# - I- to force an info message, but do not show the original sql state and error code
+# - W to force a warning
+# - W- to force a warning, but do not show the original sql state and error code
+# - E to force an error
+# - E- to force an error, but do not show the original sql state and error code
+# Example 1: to force Oracle stored procedure compilation issues to produce
+# errors instead of warnings, the following errorOverride can be used: 99999:17110:E
+# Example 2: to force SQL Server PRINT messages to be displayed as info messages (without SQL state and error
+# code details) instead of warnings, the following errorOverride can be used: S0001:0:I-
 # Flyway Pro and Flyway Enterprise only
 # flyway.errorOverrides=
 
@@ -283,7 +300,14 @@ flyway.url=
 # Flyway Pro and Flyway Enterprise only
 # flyway.oracle.sqlplus=
 
-# Flyway's license key.
+# Whether Flyway should issue a warning instead of an error whenever it encounters an Oracle SQL*Plus
+# statement it doesn't yet support. (default: false)
+# Flyway Pro and Flyway Enterprise only
+# flyway.oracle.sqlplusWarn=
+
+# Your Flyway license key (FL01...). Not yet a Flyway Pro or Enterprise Edition customer?
+# Request your Flyway trial license key st https://flywaydb.org/download/
+# to try out Flyway Pro and Enterprise Edition features free for 30 days.
 # Flyway Pro and Flyway Enterprise only
 # flyway.licenseKey=
 ```

documentation/envvars.md

@@ -307,6 +307,10 @@ The following environment variables are supported:
         <td>FLYWAY_ORACLE_SQLPLUS {% include pro.html %}</td>
         <td>Enable Flyway's support for <a href="/documentation/database/oracle#sqlplus-commands">Oracle SQL*Plus commands</a></td>
     </tr>
+    <tr id="FLYWAY_ORACLE_SQLPLUS_WARN">
+        <td>FLYWAY_ORACLE_SQLPLUS_WARN {% include pro.html %}</td>
+        <td>Whether Flyway should issue a warning instead of an error whenever it encounters an Oracle SQL*Plus statement it doesn't yet support.</td>
+    </tr>
     <tr id="FLYWAY_LICENSE_KEY">
         <td>FLYWAY_LICENSE_KEY {% include pro.html %}</td>
         <td>Your Flyway license key (FL01...). Not yet a Flyway Pro or Enterprise Edition customer? Request your <a href="" data-toggle="modal" data-target="#flyway-trial-license-modal">Flyway trial license key</a> to try out Flyway Pro and Enterprise Edition features free for 30 days.</td>

documentation/gradle/migrate.md

@@ -325,6 +325,7 @@ Migrates the schema to the latest version. Flyway will create the schema history
             Omit to use the default mode of executing the SQL statements directly against the database.</td>
     </tr>
     {% include cfg/oracleSqlplus.html %}
+    {% include cfg/oracleSqlplusWarn.html %}
     {% include cfg/licenseKey.html %}
     </tbody>
 </table>
@@ -379,6 +380,7 @@ flyway {
     errorOverrides = ['99999:17110:E', '42001:42001:W']
     dryRunOutput = '/my/sql/dryrun-outputfile.sql'
     oracleSqlplus = true 
+    oracleSqlplusWarn = true 
 }
 ```
 

documentation/gradle/undo.md

@@ -229,6 +229,7 @@ subtitle: 'gradle flywayUndo'
             Omit to use the default mode of executing the SQL statements directly against the database.</td>
     </tr>
     {% include cfg/oracleSqlplus.html %}
+    {% include cfg/oracleSqlplusWarn.html %}
     {% include cfg/licenseKey.html %}
     </tbody>
 </table>
@@ -271,6 +272,8 @@ flyway {
     installedBy = "my-user"
     errorOverrides = ['99999:17110:E', '42001:42001:W']
     dryRunOutput = '/my/sql/dryrun-outputfile.sql'
+    oracleSqlplus = true 
+    oracleSqlplusWarn = true 
 }
 ```
 

documentation/gradle/validate.md

@@ -237,6 +237,8 @@ Validation fails if
             warning is logged and Flyway continues normally. This is useful for situations where one must be able to redeploy
             an older version of the application after the database has been migrated by a newer one.</td>
     </tr>
+    {% include cfg/oracleSqlplus.html %}
+    {% include cfg/oracleSqlplusWarn.html %}
     {% include cfg/licenseKey.html %}
     </tbody>
 </table>
@@ -278,6 +280,8 @@ flyway {
     ignoreIgnoredMigrations = false
     ignorePendingMigrations = false
     ignoreFutureMigrations = false
+    oracleSqlplus = true 
+    oracleSqlplusWarn = true 
 }
 ```
 

documentation/maven/migrate.md

@@ -360,6 +360,7 @@ Migrates the schema to the latest version. Flyway will create the schema history
             Omit to use the default mode of executing the SQL statements directly against the database.</td>
     </tr>
     {% include cfg/oracleSqlplus.html %}
+    {% include cfg/oracleSqlplusWarn.html %}
     {% include cfg/licenseKey.html %}
     </tbody>
 </table>
@@ -440,6 +441,7 @@ Migrates the schema to the latest version. Flyway will create the schema history
     </errorOverrides>
     <dryRunOutput>/my/sql/dryrun-outputfile.sql</dryRunOutput>
     <oracle.sqlplus>true</oracle.sqlplus>
+    <oracle.sqlplusWarn>true</oracle.sqlplusWarn>
 </configuration>
 ```
 

documentation/maven/undo.md

@@ -260,6 +260,7 @@ subtitle: 'mvn flyway:undo'
             Omit to use the default mode of executing the SQL statements directly against the database.</td>
     </tr>
     {% include cfg/oracleSqlplus.html %}
+    {% include cfg/oracleSqlplusWarn.html %}
     {% include cfg/licenseKey.html %}
     </tbody>
 </table>
@@ -328,6 +329,8 @@ subtitle: 'mvn flyway:undo'
         <errorOverride>42001:42001:W</errorOverride>
     </errorOverrides>
     <dryRunOutput>/my/sql/dryrun-outputfile.sql</dryRunOutput>
+    <oracle.sqlplus>true</oracle.sqlplus>
+    <oracle.sqlplusWarn>true</oracle.sqlplusWarn>
 </configuration>
 ```
 

documentation/maven/validate.md

@@ -270,6 +270,8 @@ Validation fails if
         <td><i>project.basedir</i> (where the POM resides)</td>
         <td>The working directory to consider when dealing with relative paths for both config files and locations.</td>
     </tr>
+    {% include cfg/oracleSqlplus.html %}
+    {% include cfg/oracleSqlplusWarn.html %}
     {% include cfg/licenseKey.html %}
     </tbody>
 </table>
@@ -329,6 +331,8 @@ Validation fails if
     <ignoreIgnoredMigrations>false</ignoreIgnoredMigrations>
     <ignorePendingMigrations>false</ignorePendingMigrations>
     <ignoreFutureMigrations>false</ignoreFutureMigrations>
+    <oracle.sqlplus>true</oracle.sqlplus>
+    <oracle.sqlplusWarn>true</oracle.sqlplusWarn>
     <skip>false</skip>
     <configFiles>
         <configFile>myConfig.conf</configFile>

documentation/releaseNotes.html

@@ -14,6 +14,7 @@ <h3>New features</h3>
     <ul>
         {% include issue.html id="865" title="Custom tablespace for schema history table" %}
         {% include issue.html id="1062" title="API: Make it possible to use pre-instantiated Java-based migrations" %}
+        {% include issue.html id="2120" title="Add new oracle.sqlplusWarn setting" pro=true %}
         {% include issue.html id="2167" title="Allow versioned migration names like V12.sql (no separator, no description)" %}
         {% include issue.html id="2178" title="PostgreSQL 11 support" pr="2194" %}
         {% include issue.html id="2189" title="Gradle 5.0 support" %}
@@ -28,6 +29,7 @@ <h3>Changes</h3>
 
     <h3>Incompatible changes</h3>
     <ul>
+        {% include issue.html id="2120" title="Unsupported Oracle SQL*Plus now throw an error by default" pro=true %}
         {% include issue.html id="2188" title="Discontinue Java 6 support" enterprise=true %}
         {% include issue.html id="2218" title="Remove deprecated APIs and settings" %}
     </ul>