]> git.ipfire.org Git - thirdparty/psycopg.git/commitdiff
docs: add warning disclaimer about pipeline mode
authorDaniele Varrazzo <daniele.varrazzo@gmail.com>
Sat, 7 May 2022 14:21:07 +0000 (16:21 +0200)
committerDaniele Varrazzo <daniele.varrazzo@gmail.com>
Sat, 7 May 2022 14:21:07 +0000 (16:21 +0200)
docs/advanced/pipeline.rst

index 423ef1fa09fcabeb2991fa456c4fb03bdfeb8d86..06373b33492f569369bd61c21c730d48474eb335 100644 (file)
@@ -73,6 +73,17 @@ the cursors which executed them. If a cursor had run more than one query, it
 will receive more than one result; results after the first will be available,
 in their execution order, using `~Cursor.nextset()`.
 
+.. warning::
+    The Pipeline mode is an experimental feature.
+
+    Its behaviour, especially around error condtions, hasn't been explored as
+    much as the normal request-response messages pattern, and its async nature
+    makes it inherently more complex.
+
+    As we gain more experience and feedback (which is welcome), we might find
+    bugs and shortcomings forcing us to change the current interface or
+    behaviour.
+
 .. warning::
     Certain features are not available in pipeline mode, including: