[FLINK-21743] Document limitation of JdbcXaSinkFunction for MySQL sup…

…port
mbalassi · Apr 14, 2021 · 5ac1073 · 5ac1073
1 parent 73e777b
commit 5ac1073
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/docs/content/docs/connectors/datastream/jdbc.md b/docs/content/docs/connectors/datastream/jdbc.md
@@ -142,7 +142,12 @@ public class JdbcSinkExample {
 
 ## `JdbcSink.exactlyOnceSink`
 
-Since 1.13, Flink JDBC sink supports exactly-once mode. The implementation relies on the JDBC driver support of XA [standard](https://pubs.opengroup.org/onlinepubs/009680699/toc.pdf).
+Since 1.13, Flink JDBC sink supports exactly-once mode. 
+The implementation relies on the JDBC driver support of XA 
+[standard](https://pubs.opengroup.org/onlinepubs/009680699/toc.pdf).
+
+Attention: In 1.13, Flink JDBC sink does not support exactly-once mode with MySQL or other databases
+that do not support multiple XA transaction per connection. We will improve the support in FLINK-22239.
 
 To use it, create a sink using `exactlyOnceSink()` method as above and additionally provide:
 - {{< javadoc name="exactly-once options" file="org/apache/flink/connector/jdbc/JdbcExactlyOnceOptions.html" >}}

diff --git a/...k-connector-jdbc/src/main/java/org/apache/flink/connector/jdbc/xa/JdbcXaSinkFunction.java b/...k-connector-jdbc/src/main/java/org/apache/flink/connector/jdbc/xa/JdbcXaSinkFunction.java
@@ -120,6 +120,10 @@
  * </tbody>
  * </table>
  *
+ * <p>Attention: JdbcXaSinkFunction does not support exactly-once mode with MySQL or other databases
+ * that do not support multiple XA transaction per connection. We will improve the support in
+ * FLINK-22239.
+ *
  * @since 1.13
  */
 @Internal