Added notes for flyway/flyway#1289

flyway · Jul 9, 2018 · 661da8c · 661da8c
1 parent 1c4fb8b
commit 661da8c
Show file tree

Hide file tree

Showing 17 changed files with 55 additions and 128 deletions.
diff --git a/documentation/api/javadoc/index-all.html b/documentation/api/javadoc/index-all.html
@@ -683,7 +683,7 @@ <h2 class="title">E</h2>
 </dd>
 <dt><span class="memberNameLink"><a href="org/flywaydb/core/api/configuration/FluentConfiguration.html#errorOverrides-java.lang.String...-">errorOverrides(String...)</a></span> - Method in class org.flywaydb.core.api.configuration.<a href="org/flywaydb/core/api/configuration/FluentConfiguration.html" title="class in org.flywaydb.core.api.configuration">FluentConfiguration</a></dt>
 <dd>
-<div class="block">Rules for the built-in error handler that lets you override specific SQL states and errors codes from error
+<div class="block">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.</div>
 </dd>
 <dt><a href="org/flywaydb/core/api/callback/Event.html" title="enum in org.flywaydb.core.api.callback"><span class="typeNameLink">Event</span></a> - Enum in <a href="org/flywaydb/core/api/callback/package-summary.html">org.flywaydb.core.api.callback</a></dt>
@@ -930,7 +930,7 @@ <h2 class="title">G</h2>
 <dd>&nbsp;</dd>
 <dt><span class="memberNameLink"><a href="org/flywaydb/core/api/configuration/Configuration.html#getErrorOverrides--">getErrorOverrides()</a></span> - Method in interface org.flywaydb.core.api.configuration.<a href="org/flywaydb/core/api/configuration/Configuration.html" title="interface in org.flywaydb.core.api.configuration">Configuration</a></dt>
 <dd>
-<div class="block">Rules for the built-in error handler that lets you override specific SQL states and errors codes from error
+<div class="block">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.</div>
 </dd>
 <dt><span class="memberNameLink"><a href="org/flywaydb/core/api/configuration/FluentConfiguration.html#getErrorOverrides--">getErrorOverrides()</a></span> - Method in class org.flywaydb.core.api.configuration.<a href="org/flywaydb/core/api/configuration/FluentConfiguration.html" title="class in org.flywaydb.core.api.configuration">FluentConfiguration</a></dt>
@@ -1813,12 +1813,12 @@ <h2 class="title">S</h2>
 </dd>
 <dt><span class="memberNameLink"><a href="org/flywaydb/core/api/configuration/ClassicConfiguration.html#setErrorOverrides-java.lang.String...-">setErrorOverrides(String...)</a></span> - Method in class org.flywaydb.core.api.configuration.<a href="org/flywaydb/core/api/configuration/ClassicConfiguration.html" title="class in org.flywaydb.core.api.configuration">ClassicConfiguration</a></dt>
 <dd>
-<div class="block">Rules for the built-in error handler that lets you override specific SQL states and errors codes from error
+<div class="block">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.</div>
 </dd>
 <dt><span class="memberNameLink"><a href="org/flywaydb/core/Flyway.html#setErrorOverrides-java.lang.String...-">setErrorOverrides(String...)</a></span> - Method in class org.flywaydb.core.<a href="org/flywaydb/core/Flyway.html" title="class in org.flywaydb.core">Flyway</a></dt>
 <dd>
-<div class="block">Rules for the built-in error handler that lets you override specific SQL states and errors codes from error
+<div class="block">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.</div>
 </dd>
 <dt><span class="memberNameLink"><a href="org/flywaydb/core/api/logging/LogFactory.html#setFallbackLogCreator-org.flywaydb.core.api.logging.LogCreator-">setFallbackLogCreator(LogCreator)</a></span> - Static method in class org.flywaydb.core.api.logging.<a href="org/flywaydb/core/api/logging/LogFactory.html" title="class in org.flywaydb.core.api.logging">LogFactory</a></dt>

diff --git a/documentation/api/javadoc/org/flywaydb/core/Flyway.html b/documentation/api/javadoc/org/flywaydb/core/Flyway.html
@@ -304,7 +304,7 @@ <h3>Method Summary</h3>
 <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../org/flywaydb/core/Flyway.html#getErrorOverrides--">getErrorOverrides</a></span>&#8203;()</code></th>
 <td class="colLast">
-<div class="block">Rules for the built-in error handler that lets you override specific SQL states and errors codes from error
+<div class="block">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.</div>
 </td>
 </tr>
@@ -693,7 +693,7 @@ <h3>Method Summary</h3>
 <td class="colFirst"><code>void</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../org/flywaydb/core/Flyway.html#setErrorOverrides-java.lang.String...-">setErrorOverrides</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>...&nbsp;errorOverrides)</code></th>
 <td class="colLast">
-<div class="block">Rules for the built-in error handler that lets you override specific SQL states and errors codes from error
+<div class="block">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.</div>
 </td>
 </tr>
@@ -1633,7 +1633,7 @@ <h4>getErrorHandlers</h4>
 <h4>getErrorOverrides</h4>
 <pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;getErrorOverrides&#8203;()</pre>
 <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../org/flywaydb/core/api/configuration/Configuration.html#getErrorOverrides--">Configuration</a></code></span></div>
-<div class="block">Rules for the built-in error handler that lets you override specific SQL states and errors codes from error
+<div class="block">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.
  <p>Each error override has the following format: <code>STATE:12345:W</code>.
  It is a 5 character SQL state, a colon, the SQL error code, a colon and finally the desired
@@ -1825,7 +1825,7 @@ <h4>setErrorHandlersAsClassNames</h4>
 <li class="blockList">
 <h4>setErrorOverrides</h4>
 <pre>public&nbsp;void&nbsp;setErrorOverrides&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>...&nbsp;errorOverrides)</pre>
-<div class="block">Rules for the built-in error handler that lets you override specific SQL states and errors codes from error
+<div class="block">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.
  <p>Each error override has the following format: <code>STATE:12345:W</code>.
  It is a 5 character SQL state, a colon, the SQL error code, a colon and finally the desired

diff --git a/documentation/api/javadoc/org/flywaydb/core/api/configuration/ClassicConfiguration.html b/documentation/api/javadoc/org/flywaydb/core/api/configuration/ClassicConfiguration.html
@@ -286,7 +286,7 @@ <h3>Method Summary</h3>
 <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../org/flywaydb/core/api/configuration/ClassicConfiguration.html#getErrorOverrides--">getErrorOverrides</a></span>&#8203;()</code></th>
 <td class="colLast">
-<div class="block">Rules for the built-in error handler that lets you override specific SQL states and errors codes from error
+<div class="block">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.</div>
 </td>
 </tr>
@@ -644,7 +644,7 @@ <h3>Method Summary</h3>
 <td class="colFirst"><code>void</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../org/flywaydb/core/api/configuration/ClassicConfiguration.html#setErrorOverrides-java.lang.String...-">setErrorOverrides</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>...&nbsp;errorOverrides)</code></th>
 <td class="colLast">
-<div class="block">Rules for the built-in error handler that lets you override specific SQL states and errors codes from error
+<div class="block">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.</div>
 </td>
 </tr>
@@ -1527,7 +1527,7 @@ <h4>getErrorHandlers</h4>
 <h4>getErrorOverrides</h4>
 <pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;getErrorOverrides&#8203;()</pre>
 <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/flywaydb/core/api/configuration/Configuration.html#getErrorOverrides--">Configuration</a></code></span></div>
-<div class="block">Rules for the built-in error handler that lets you override specific SQL states and errors codes from error
+<div class="block">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.
  <p>Each error override has the following format: <code>STATE:12345:W</code>.
  It is a 5 character SQL state, a colon, the SQL error code, a colon and finally the desired
@@ -1674,7 +1674,7 @@ <h4>setErrorHandlersAsClassNames</h4>
 <li class="blockList">
 <h4>setErrorOverrides</h4>
 <pre>public&nbsp;void&nbsp;setErrorOverrides&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>...&nbsp;errorOverrides)</pre>
-<div class="block">Rules for the built-in error handler that lets you override specific SQL states and errors codes from error
+<div class="block">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.
  <p>Each error override has the following format: <code>STATE:12345:W</code>.
  It is a 5 character SQL state, a colon, the SQL error code, a colon and finally the desired

diff --git a/documentation/api/javadoc/org/flywaydb/core/api/configuration/Configuration.html b/documentation/api/javadoc/org/flywaydb/core/api/configuration/Configuration.html
@@ -215,7 +215,7 @@ <h3>Method Summary</h3>
 <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../org/flywaydb/core/api/configuration/Configuration.html#getErrorOverrides--">getErrorOverrides</a></span>&#8203;()</code></th>
 <td class="colLast">
-<div class="block">Rules for the built-in error handler that lets you override specific SQL states and errors codes from error
+<div class="block">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.</div>
 </td>
 </tr>
@@ -1005,7 +1005,7 @@ <h4>getErrorHandlers</h4>
 <li class="blockList">
 <h4>getErrorOverrides</h4>
 <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;getErrorOverrides&#8203;()</pre>
-<div class="block">Rules for the built-in error handler that lets you override specific SQL states and errors codes from error
+<div class="block">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.
  <p>Each error override has the following format: <code>STATE:12345:W</code>.
  It is a 5 character SQL state, a colon, the SQL error code, a colon and finally the desired

diff --git a/documentation/api/javadoc/org/flywaydb/core/api/configuration/FluentConfiguration.html b/documentation/api/javadoc/org/flywaydb/core/api/configuration/FluentConfiguration.html
@@ -353,7 +353,7 @@ <h3>Method Summary</h3>
 <td class="colFirst"><code><a href="../../../../../org/flywaydb/core/api/configuration/FluentConfiguration.html" title="class in org.flywaydb.core.api.configuration">FluentConfiguration</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../org/flywaydb/core/api/configuration/FluentConfiguration.html#errorOverrides-java.lang.String...-">errorOverrides</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>...&nbsp;errorOverrides)</code></th>
 <td class="colLast">
-<div class="block">Rules for the built-in error handler that lets you override specific SQL states and errors codes from error
+<div class="block">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.</div>
 </td>
 </tr>
@@ -417,7 +417,7 @@ <h3>Method Summary</h3>
 <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../org/flywaydb/core/api/configuration/FluentConfiguration.html#getErrorOverrides--">getErrorOverrides</a></span>&#8203;()</code></th>
 <td class="colLast">
-<div class="block">Rules for the built-in error handler that lets you override specific SQL states and errors codes from error
+<div class="block">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.</div>
 </td>
 </tr>
@@ -1511,7 +1511,7 @@ <h4>getErrorHandlers</h4>
 <h4>getErrorOverrides</h4>
 <pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;getErrorOverrides&#8203;()</pre>
 <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/flywaydb/core/api/configuration/Configuration.html#getErrorOverrides--">Configuration</a></code></span></div>
-<div class="block">Rules for the built-in error handler that lets you override specific SQL states and errors codes from error
+<div class="block">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.
  <p>Each error override has the following format: <code>STATE:12345:W</code>.
  It is a 5 character SQL state, a colon, the SQL error code, a colon and finally the desired
@@ -1703,7 +1703,7 @@ <h4>errorHandlers</h4>
 <li class="blockList">
 <h4>errorOverrides</h4>
 <pre>public&nbsp;<a href="../../../../../org/flywaydb/core/api/configuration/FluentConfiguration.html" title="class in org.flywaydb.core.api.configuration">FluentConfiguration</a>&nbsp;errorOverrides&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>...&nbsp;errorOverrides)</pre>
-<div class="block">Rules for the built-in error handler that lets you override specific SQL states and errors codes from error
+<div class="block">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.
  <p>Each error override has the following format: <code>STATE:12345:W</code>.
  It is a 5 character SQL state, a colon, the SQL error code, a colon and finally the desired

diff --git a/...tation/api/javadoc/org/flywaydb/core/api/configuration/class-use/FluentConfiguration.html b/...tation/api/javadoc/org/flywaydb/core/api/configuration/class-use/FluentConfiguration.html
@@ -292,7 +292,7 @@ <h3>Uses of <a href="../../../../../../org/flywaydb/core/api/configuration/Fluen
 <td class="colFirst"><code><a href="../../../../../../org/flywaydb/core/api/configuration/FluentConfiguration.html" title="class in org.flywaydb.core.api.configuration">FluentConfiguration</a></code></td>
 <th class="colSecond" scope="row"><span class="typeNameLabel">FluentConfiguration.</span><code><span class="memberNameLink"><a href="../../../../../../org/flywaydb/core/api/configuration/FluentConfiguration.html#errorOverrides-java.lang.String...-">errorOverrides</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>...&nbsp;errorOverrides)</code></th>
 <td class="colLast">
-<div class="block">Rules for the built-in error handler that lets you override specific SQL states and errors codes from error
+<div class="block">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.</div>
 </td>
 </tr>

diff --git a/documentation/callbacks.md b/documentation/callbacks.md
@@ -27,6 +27,18 @@ These are the events Flyway supports:
         <td>beforeEachMigrate</td>
         <td>Before every single migration during Migrate</td>
     </tr>
+    <tr>
+        <td>beforeEachMigrateStatement {% include pro.html %}</td>
+        <td>Before every single statement of a migration during Migrate</td>
+    </tr>
+    <tr>
+        <td>afterEachMigrateStatement {% include pro.html %}</td>
+        <td>After every single successful statement of a migration during Migrate</td>
+    </tr>
+    <tr>
+        <td>afterEachMigrateStatementError {% include pro.html %}</td>
+        <td>After every single failed statement of a migration during Migrate</td>
+    </tr>
     <tr>
         <td>afterEachMigrate</td>
         <td>After every single successful migration during Migrate</td>
@@ -52,6 +64,18 @@ These are the events Flyway supports:
         <td>beforeEachUndo {% include pro.html %}</td>
         <td>Before every single migration during Undo</td>
     </tr>
+    <tr>
+        <td>beforeEachUndoStatement {% include pro.html %}</td>
+        <td>Before every single statement of a migration during Undo</td>
+    </tr>
+    <tr>
+        <td>afterEachUndoStatement {% include pro.html %}</td>
+        <td>After every single successful statement of a migration during Undo</td>
+    </tr>
+    <tr>
+        <td>afterEachUndoStatementError {% include pro.html %}</td>
+        <td>After every single failed statement of a migration during Undo</td>
+    </tr>
     <tr>
         <td>afterEachUndo {% include pro.html %}</td>
         <td>After every single successful migration during Undo</td>