Document MySQL cursor API limitation with ProxySQL (#1259)

Closes #1258 Signed-off-by: Thomas Segismont <[email protected]> Signed-off-by: Thomas Segismont <[email protected]>
eclipse-vertx · Nov 15, 2022 · 2e09f59 · 2e09f59
1 parent a985c7e
commit 2e09f59
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 1 deletion.
diff --git a/vertx-mysql-client/src/main/asciidoc/cursor_warning.adoc b/vertx-mysql-client/src/main/asciidoc/cursor_warning.adoc
@@ -0,0 +1,11 @@
+[CAUTION]
+====
+At the time of writing, you cannot use the following features if you connect to your database through ProxySQL.
+If you try, you will see this error message:
+
+----
+RECEIVED AN UNKNOWN COMMAND: 28 -- PLEASE REPORT A BUG
+----
+
+This is because the proxy does not handle a type of command (`COM_STMT_FETCH`) that is required to fetch rows from a cursor.
+====
diff --git a/vertx-sql-client/src/main/asciidoc/cursor.adoc b/vertx-sql-client/src/main/asciidoc/cursor.adoc
@@ -1,6 +1,8 @@
 == Cursors and streaming
 
-By default prepared query execution fetches all rows, you can use a
+include::cursor_warning.adoc[opts=optional]
+
+By default, prepared query execution fetches all rows, you can use a
 {@link io.vertx.sqlclient.Cursor} to control the amount of rows you want to read:
 
 [source,$lang]