feat: add Close wrappers to pgconn.pyx

diff --git a/psycopg/psycopg/pq/_pq_ctypes.py b/psycopg/psycopg/pq/_pq_ctypes.py
index 9ca1d12918f6d18f24d2f3394be8ebc712812e03..53d9a9bc1bafe0aa162968a03b299e8ec02774ec 100644 (file)
--- a/psycopg/psycopg/pq/_pq_ctypes.py
+++ b/psycopg/psycopg/pq/_pq_ctypes.py
@@ -302,6 +302,37 @@ PQdescribePortal = pq.PQdescribePortal
 PQdescribePortal.argtypes = [PGconn_ptr, c_char_p]
 PQdescribePortal.restype = PGresult_ptr
 
+_PQclosePrepared = None
+_PQclosePortal = None
+
+if libpq_version >= 170000:
+    _PQclosePrepared = pq.PQclosePrepared
+    _PQclosePrepared.argtypes = [PGconn_ptr, c_char_p]
+    _PQclosePrepared.restype = PGresult_ptr
+
+    _PQclosePortal = pq.PQclosePortal
+    _PQclosePortal.argtypes = [PGconn_ptr, c_char_p]
+    _PQclosePortal.restype = PGresult_ptr
+
+
+def PQclosePrepared(pgconn: PGconn_struct) -> int:
+    if not _PQclosePrepared:
+        raise NotSupportedError(
+            "PQclosePrepared requires libpq from PostgreSQL 17,"
+            f" {libpq_version} available instead"
+        )
+    return _PQclosePrepared(pgconn)
+
+
+def PQclosePortal(pgconn: PGconn_struct) -> int:
+    if not _PQclosePortal:
+        raise NotSupportedError(
+            "PQclosePortal requires libpq from PostgreSQL 17,"
+            f" {libpq_version} available instead"
+        )
+    return _PQclosePortal(pgconn)
+
+
 PQresultStatus = pq.PQresultStatus
 PQresultStatus.argtypes = [PGresult_ptr]
 PQresultStatus.restype = c_int
@@ -495,6 +526,37 @@ PQsendDescribePortal = pq.PQsendDescribePortal
 PQsendDescribePortal.argtypes = [PGconn_ptr, c_char_p]
 PQsendDescribePortal.restype = c_int
 
+_PQsendClosePrepared = None
+_PQsendClosePortal = None
+
+if libpq_version >= 170000:
+    _PQsendClosePrepared = pq.PQsendClosePrepared
+    _PQsendClosePrepared.argtypes = [PGconn_ptr, c_char_p]
+    _PQsendClosePrepared.restype = c_int
+
+    _PQsendClosePortal = pq.PQsendClosePortal
+    _PQsendClosePortal.argtypes = [PGconn_ptr, c_char_p]
+    _PQsendClosePortal.restype = c_int
+
+
+def PQsendClosePrepared(pgconn: PGconn_struct) -> int:
+    if not _PQsendClosePrepared:
+        raise NotSupportedError(
+            "PQsendClosePrepared requires libpq from PostgreSQL 17,"
+            f" {libpq_version} available instead"
+        )
+    return _PQsendClosePrepared(pgconn)
+
+
+def PQsendClosePortal(pgconn: PGconn_struct) -> int:
+    if not _PQsendClosePortal:
+        raise NotSupportedError(
+            "PQsendClosePortal requires libpq from PostgreSQL 17,"
+            f" {libpq_version} available instead"
+        )
+    return _PQsendClosePortal(pgconn)
+
+
 PQgetResult = pq.PQgetResult
 PQgetResult.argtypes = [PGconn_ptr]
 PQgetResult.restype = PGresult_ptr

diff --git a/psycopg/psycopg/pq/_pq_ctypes.pyi b/psycopg/psycopg/pq/_pq_ctypes.pyi
index 545fec42155bef80129f180ec1c55d12b6718696..bf7d85030b58e0bf12cceefdd1d5eafca1b74f7a 100644 (file)
--- a/psycopg/psycopg/pq/_pq_ctypes.pyi
+++ b/psycopg/psycopg/pq/_pq_ctypes.pyi
@@ -162,6 +162,8 @@ def PQexec(arg1: Optional[PGconn_struct], arg2: bytes) -> PGresult_struct: ...
 def PQexecParams(arg1: Optional[PGconn_struct], arg2: bytes, arg3: int, arg4: _Pointer[c_uint], arg5: _Pointer[c_char_p], arg6: _Pointer[c_int], arg7: _Pointer[c_int], arg8: int) -> PGresult_struct: ...
 def PQdescribePrepared(arg1: Optional[PGconn_struct], arg2: bytes) -> PGresult_struct: ...
 def PQdescribePortal(arg1: Optional[PGconn_struct], arg2: bytes) -> PGresult_struct: ...
+def PQclosePrepared(arg1: Optional[PGconn_struct], arg2: bytes) -> PGresult_struct: ...
+def PQclosePortal(arg1: Optional[PGconn_struct], arg2: bytes) -> PGresult_struct: ...
 def PQresultStatus(arg1: Optional[PGresult_struct]) -> int: ...
 def PQresultErrorField(arg1: Optional[PGresult_struct], arg2: int) -> Optional[bytes]: ...
 def PQclear(arg1: Optional[PGresult_struct]) -> None: ...
@@ -190,6 +192,8 @@ def PQsendQuery(arg1: Optional[PGconn_struct], arg2: bytes) -> int: ...
 def PQsendQueryParams(arg1: Optional[PGconn_struct], arg2: bytes, arg3: int, arg4: _Pointer[c_uint], arg5: _Pointer[c_char_p], arg6: _Pointer[c_int], arg7: _Pointer[c_int], arg8: int) -> int: ...
 def PQsendDescribePrepared(arg1: Optional[PGconn_struct], arg2: bytes) -> int: ...
 def PQsendDescribePortal(arg1: Optional[PGconn_struct], arg2: bytes) -> int: ...
+def PQsendClosePrepared(arg1: Optional[PGconn_struct], arg2: bytes) -> int: ...
+def PQsendClosePortal(arg1: Optional[PGconn_struct], arg2: bytes) -> int: ...
 def PQgetResult(arg1: Optional[PGconn_struct]) -> PGresult_struct: ...
 def PQconsumeInput(arg1: Optional[PGconn_struct]) -> int: ...
 def PQisBusy(arg1: Optional[PGconn_struct]) -> int: ...

diff --git a/psycopg/psycopg/pq/abc.py b/psycopg/psycopg/pq/abc.py
index 971d00eea469784ef700b6a6f9d4e6a1234d91dd..e8ece59f6a0e4bc71b2661be8e53f1c9a0d2efdc 100644 (file)
--- a/psycopg/psycopg/pq/abc.py
+++ b/psycopg/psycopg/pq/abc.py
@@ -196,6 +196,18 @@ class PGconn(Protocol):
     def send_describe_portal(self, name: bytes) -> None:
         ...
 
+    def close_prepared(self, name: bytes) -> "PGresult":
+        ...
+
+    def send_close_prepared(self, name: bytes) -> None:
+        ...
+
+    def close_portal(self, name: bytes) -> "PGresult":
+        ...
+
+    def send_close_portal(self, name: bytes) -> None:
+        ...
+
     def get_result(self) -> Optional["PGresult"]:
         ...
 

diff --git a/psycopg/psycopg/pq/pq_ctypes.py b/psycopg/psycopg/pq/pq_ctypes.py
index 204e384847567d36c2904517a2fa8f38822f5f3f..07c2d95cca50d57c4823aad837441faa34b3b977 100644 (file)
--- a/psycopg/psycopg/pq/pq_ctypes.py
+++ b/psycopg/psycopg/pq/pq_ctypes.py
@@ -518,6 +518,42 @@ class PGconn:
                 f"sending describe portal failed: {error_message(self)}"
             )
 
+    def close_prepared(self, name: bytes) -> "PGresult":
+        if not isinstance(name, bytes):
+            raise TypeError(f"'name' must be bytes, got {type(name)} instead")
+        self._ensure_pgconn()
+        rv = impl.PQclosePrepared(self._pgconn_ptr, name)
+        if not rv:
+            raise e.OperationalError(f"close prepared failed: {error_message(self)}")
+        return PGresult(rv)
+
+    def send_close_prepared(self, name: bytes) -> None:
+        if not isinstance(name, bytes):
+            raise TypeError(f"bytes expected, got {type(name)} instead")
+        self._ensure_pgconn()
+        if not impl.PQsendClosePrepared(self._pgconn_ptr, name):
+            raise e.OperationalError(
+                f"sending close prepared failed: {error_message(self)}"
+            )
+
+    def close_portal(self, name: bytes) -> "PGresult":
+        if not isinstance(name, bytes):
+            raise TypeError(f"'name' must be bytes, got {type(name)} instead")
+        self._ensure_pgconn()
+        rv = impl.PQclosePortal(self._pgconn_ptr, name)
+        if not rv:
+            raise e.OperationalError(f"close portal failed: {error_message(self)}")
+        return PGresult(rv)
+
+    def send_close_portal(self, name: bytes) -> None:
+        if not isinstance(name, bytes):
+            raise TypeError(f"bytes expected, got {type(name)} instead")
+        self._ensure_pgconn()
+        if not impl.PQsendClosePortal(self._pgconn_ptr, name):
+            raise e.OperationalError(
+                f"sending close portal failed: {error_message(self)}"
+            )
+
     def get_result(self) -> Optional["PGresult"]:
         rv = impl.PQgetResult(self._pgconn_ptr)
         return PGresult(rv) if rv else None

diff --git a/psycopg_c/psycopg_c/pq/libpq.pxd b/psycopg_c/psycopg_c/pq/libpq.pxd
index 5e05e40a89ad183f2bf261711abec7aa87aeaee7..246bae4fc21146cd21308b8394f2e0bd9672542f 100644 (file)
--- a/psycopg_c/psycopg_c/pq/libpq.pxd
+++ b/psycopg_c/psycopg_c/pq/libpq.pxd
@@ -162,6 +162,8 @@ cdef extern from "libpq-fe.h":
                              int resultFormat) nogil
     PGresult *PQdescribePrepared(PGconn *conn, const char *stmtName) nogil
     PGresult *PQdescribePortal(PGconn *conn, const char *portalName) nogil
+    PGresult *PQclosePrepared(PGconn *conn, const char *stmtName) nogil
+    PGresult *PQclosePortal(PGconn *conn, const char *portalName) nogil
     ExecStatusType PQresultStatus(const PGresult *res) nogil
     # PQresStatus: not needed, we have pretty enums
     char *PQresultErrorMessage(const PGresult *res) nogil
@@ -234,6 +236,8 @@ cdef extern from "libpq-fe.h":
                             int resultFormat) nogil
     int PQsendDescribePrepared(PGconn *conn, const char *stmtName) nogil
     int PQsendDescribePortal(PGconn *conn, const char *portalName) nogil
+    int PQsendClosePrepared(PGconn *conn, const char *stmtName) nogil
+    int PQsendClosePortal(PGconn *conn, const char *portalName) nogil
     PGresult *PQgetResult(PGconn *conn) nogil
     int PQconsumeInput(PGconn *conn) nogil
     int PQisBusy(PGconn *conn) nogil
@@ -318,4 +322,11 @@ typedef enum {
 #define PQsendFlushRequest(conn) 0
 #define PQsetTraceFlags(conn, stream) do {} while (0)
 #endif
+
+#if PG_VERSION_NUM < 170000
+#define PQclosePrepared(conn, name) NULL
+#define PQclosePortal(conn, name) NULL
+#define PQsendClosePrepared(conn, name) 0
+#define PQsendClosePortal(conn, name) 0
+#endif
 """

diff --git a/psycopg_c/psycopg_c/pq/pgconn.pyx b/psycopg_c/psycopg_c/pq/pgconn.pyx
index c6ca22b39cd0195d497d4c866b14b15016a72430..522efebaff78bbe523d3169b2068cf0dad3e0080 100644 (file)
--- a/psycopg_c/psycopg_c/pq/pgconn.pyx
+++ b/psycopg_c/psycopg_c/pq/pgconn.pyx
@@ -422,6 +422,60 @@ cdef class PGconn:
                 f"sending describe prepared failed: {error_message(self)}"
             )
 
+    def close_prepared(self, const char *name) -> PGresult:
+        if libpq.PG_VERSION_NUM < 170000:
+            raise e.NotSupportedError(
+                f"PQclosePrepared requires libpq from PostgreSQL 17,"
+                f" {libpq.PG_VERSION_NUM} available instead"
+            )
+        _ensure_pgconn(self)
+        cdef libpq.PGresult *rv = libpq.PQclosePrepared(self._pgconn_ptr, name)
+        if rv is NULL:
+            raise e.OperationalError(
+                f"close prepared failed: {error_message(self)}"
+            )
+        return PGresult._from_ptr(rv)
+
+    def send_close_prepared(self, const char *name) -> None:
+        if libpq.PG_VERSION_NUM < 170000:
+            raise e.NotSupportedError(
+                f"PQsendClosePrepared requires libpq from PostgreSQL 17,"
+                f" {libpq.PG_VERSION_NUM} available instead"
+            )
+        _ensure_pgconn(self)
+        cdef int rv = libpq.PQsendClosePrepared(self._pgconn_ptr, name)
+        if not rv:
+            raise e.OperationalError(
+                f"sending close prepared failed: {error_message(self)}"
+            )
+
+    def close_portal(self, const char *name) -> PGresult:
+        if libpq.PG_VERSION_NUM < 170000:
+            raise e.NotSupportedError(
+                f"PQclosePortal requires libpq from PostgreSQL 17,"
+                f" {libpq.PG_VERSION_NUM} available instead"
+            )
+        _ensure_pgconn(self)
+        cdef libpq.PGresult *rv = libpq.PQclosePortal(self._pgconn_ptr, name)
+        if rv is NULL:
+            raise e.OperationalError(
+                f"close prepared failed: {error_message(self)}"
+            )
+        return PGresult._from_ptr(rv)
+
+    def send_close_portal(self, const char *name) -> None:
+        if libpq.PG_VERSION_NUM < 170000:
+            raise e.NotSupportedError(
+                f"PQsendClosePortal requires libpq from PostgreSQL 17,"
+                f" {libpq.PG_VERSION_NUM} available instead"
+            )
+        _ensure_pgconn(self)
+        cdef int rv = libpq.PQsendClosePortal(self._pgconn_ptr, name)
+        if not rv:
+            raise e.OperationalError(
+                f"sending close prepared failed: {error_message(self)}"
+            )
+
     def get_result(self) -> Optional["PGresult"]:
         cdef libpq.PGresult *pgresult = libpq.PQgetResult(self._pgconn_ptr)
         if pgresult is NULL: