summaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
authorDaniele Varrazzo <daniele.varrazzo@gmail.com>2010-09-27 02:25:09 +0100
committerDaniele Varrazzo <daniele.varrazzo@gmail.com>2010-11-05 09:34:52 +0000
commit4b98e8941ff914bd526e266373c689c60ce49e9a (patch)
tree5d3b6cb0ca22e7bc7077cd5270279ad7dcdbc2ca /lib
parentd5bf400cb4dc814ab26b1f094c361cc6647e36ef (diff)
downloadpsycopg2-4b98e8941ff914bd526e266373c689c60ce49e9a.tar.gz
Added some documentation for the hstore adaptation.
Diffstat (limited to 'lib')
-rw-r--r--lib/extras.py12
1 files changed, 6 insertions, 6 deletions
diff --git a/lib/extras.py b/lib/extras.py
index e81aedb..dc98fdb 100644
--- a/lib/extras.py
+++ b/lib/extras.py
@@ -620,14 +620,14 @@ def register_hstore(conn_or_curs, globally=False, unicode=False):
The function must receive a connection or cursor as the :sql:`hstore` oid
is different in every database. The typecaster will be registered only on
the connection or cursor passed as argument. If your application uses a
- single database you can pass *globally*=True to have hstore registered on
- all the connections.
-
- Raise `~psycopg2.ProgrammingError` if hstore is not installed in the
- target database.
+ single database you can pass *globally*\=True to have hstore registered
+ on all the connections.
By default the returned dicts have string keys and values: use
- *unicode*=True to return `unicode` objects instead.
+ *unicode*\=True to return `unicode` objects instead.
+
+ Raise `~psycopg2.ProgrammingError` if the :sql:`hstore` type is not
+ installed in the target database.
"""
oids = HstoreAdapter.get_oids(conn_or_curs)
if oids is None: