From 860dbf7d0ef816597823b068711e55cbe287c488 Mon Sep 17 00:00:00 2001 From: Daniele Varrazzo Date: Sat, 7 May 2022 16:21:07 +0200 Subject: [PATCH] docs: add warning disclaimer about pipeline mode --- docs/advanced/pipeline.rst | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/advanced/pipeline.rst b/docs/advanced/pipeline.rst index 423ef1fa0..06373b334 100644 --- a/docs/advanced/pipeline.rst +++ b/docs/advanced/pipeline.rst @@ -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: -- 2.47.3