From: Daniele Varrazzo <daniele.varrazzo@gmail.com>
Date: Sun, 3 Apr 2022 00:25:55 +0000 (+0200)
Subject: docs: add note about features not supported in pipeline mode
X-Git-Tag: 3.1~120^2~9
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=dec1ad7ae1197a3a19c66842dbd552c2fea80fa6;p=thirdparty%2Fpsycopg.git

docs: add note about features not supported in pipeline mode
---

diff --git a/docs/advanced/pipeline.rst b/docs/advanced/pipeline.rst
index 6a50f4cd5..dc4c18451 100644
--- a/docs/advanced/pipeline.rst
+++ b/docs/advanced/pipeline.rst
@@ -68,6 +68,14 @@ 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::
+    Certanin features are not available in pipeline mode, including:
+
+    - COPY is not supported in pipeline mode by PostgreSQL.
+    - `Cursor.stream()` doesn't make sense in pipeline mode (its job is the
+      opposite of batching!)
+    - `ServerCursor` are currently not implemented in pipeline mode.
+
 .. note::
     Starting from Psycopg 3.1, `Cursor.executemany()` is optimised to make use
     of pipeline mode.