summaryrefslogtreecommitdiff
path: root/doc/src/connection.rst
diff options
context:
space:
mode:
authorDaniele Varrazzo <daniele.varrazzo@gmail.com>2011-02-23 01:53:25 +0000
committerDaniele Varrazzo <daniele.varrazzo@gmail.com>2011-02-23 01:53:25 +0000
commit1db9c9b8ce99bdc863d232cf06301edb53e2ed5b (patch)
treeb1b24c242946091ee64b0ce2562d68fc61e43a9d /doc/src/connection.rst
parent66555c5f11728f25634dae70c37b02135d03b387 (diff)
downloadpsycopg2-1db9c9b8ce99bdc863d232cf06301edb53e2ed5b.tar.gz
The cursor name can be a non-valid PostgreSQL identifier
Diffstat (limited to 'doc/src/connection.rst')
-rw-r--r--doc/src/connection.rst21
1 files changed, 17 insertions, 4 deletions
diff --git a/doc/src/connection.rst b/doc/src/connection.rst
index bb46a49..0103258 100644
--- a/doc/src/connection.rst
+++ b/doc/src/connection.rst
@@ -25,11 +25,24 @@ The ``connection`` class
Return a new `cursor` object using the connection.
- If `name` is specified, the returned cursor will be a *server
- side* (or *named*) cursor. Otherwise the cursor will be *client side*.
- See :ref:`server-side-cursors` for further details.
+ If *name* is specified, the returned cursor will be a :ref:`server
+ side cursor <server-side-cursors>` (also known as *named cursor*).
+ Otherwise it will be a regular *client side* cursor.
- The `cursor_factory` argument can be used to create non-standard
+ The name can be a string not valid as a PostgreSQL identifier: for
+ example it may start with a digit and contain non-alphanumeric
+ characters and quotes.
+
+ .. versionchanged:: 2.4
+ previously only valid PostgreSQL identifiers were accepted as
+ cursor name.
+
+ .. warning::
+ It is unsafe to expose the *name* to an untrusted source, for
+ instance you shouldn't allow *name* to be read from a HTML form.
+ Consider it as part of the query, not as a query parameter.
+
+ The *cursor_factory* argument can be used to create non-standard
cursors. The class returned should be a subclass of
`psycopg2.extensions.cursor`. See :ref:`subclassing-cursor` for
details.