summaryrefslogtreecommitdiff
path: root/doc/src/cursor.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/src/cursor.rst')
-rw-r--r--doc/src/cursor.rst18
1 files changed, 18 insertions, 0 deletions
diff --git a/doc/src/cursor.rst b/doc/src/cursor.rst
index 1d7098f..c6b04cf 100644
--- a/doc/src/cursor.rst
+++ b/doc/src/cursor.rst
@@ -632,6 +632,24 @@ The ``cursor`` class
using Unicode data instead of bytes.
+ .. rubric:: Interoperation with other C API modules
+
+ .. attribute:: pgresult_ptr
+
+ Return the cursor's internal `!PGresult*` as integer. Useful to pass
+ the libpq raw result structure to C functions, e.g. via `ctypes`::
+
+ >>> import ctypes
+ >>> libpq = ctypes.pydll.LoadLibrary(ctypes.util.find_library('pq'))
+ >>> libpq.PQcmdStatus.argtypes = [ctypes.c_void_p]
+ >>> libpq.PQcmdStatus.restype = ctypes.c_char_p
+
+ >>> curs.execute("select 'x'")
+ >>> libpq.PQcmdStatus(curs.pgresult_ptr)
+ b'SELECT 1'
+
+ .. versionadded:: 2.8
+
.. testcode::
:hide: