psycopg/psycopg2
1
1
Fork 0
mirror of https://github.com/psycopg/psycopg2.git synced 2025-11-04 09:47:30 +03:00
Code Issues Packages Projects Releases Wiki Activity

Better link from docs to "json and jsonb" data types

Browse Source
This commit is contained in:
Daniele Varrazzo 2019-03-05 17:31:45 +00:00
parent c929f20048
commit 3ae9dfd545
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
doc/src/extras.rst
View File

@ -531,8 +531,8 @@ JSON_ adaptation
added |jsonb| support. In previous versions |jsonb| values are returned added |jsonb| support. In previous versions |jsonb| values are returned
as strings. See :ref:`the FAQ <faq-jsonb-adapt>` for a workaround. as strings. See :ref:`the FAQ <faq-jsonb-adapt>` for a workaround.
Psycopg can adapt Python objects to and from the PostgreSQL |pgjson|_ and Psycopg can adapt Python objects to and from the PostgreSQL |jsons|_
|jsonb| types. With PostgreSQL 9.2 and following versions adaptation is types. With PostgreSQL 9.2 and following versions adaptation is
available out-of-the-box. To use JSON data with previous database versions available out-of-the-box. To use JSON data with previous database versions
(either with the `9.1 json extension`__, but even if you want to convert text (either with the `9.1 json extension`__, but even if you want to convert text
fields to JSON) you can use the `register_json()` function. fields to JSON) you can use the `register_json()` function.
@ -543,9 +543,10 @@ The Python :py:mod:`json` module is used by default to convert Python objects
to JSON and to parse data from the database. to JSON and to parse data from the database.
.. _JSON: https://www.json.org/ .. _JSON: https://www.json.org/
.. |pgjson| replace:: :sql:`json` .. |json| replace:: :sql:`json`
.. |jsonb| replace:: :sql:`jsonb` .. |jsonb| replace:: :sql:`jsonb`
.. _pgjson: https://www.postgresql.org/docs/current/static/datatype-json.html .. |jsons| replace:: |json| and |jsonb|
.. _jsons: https://www.postgresql.org/docs/current/static/datatype-json.html
In order to pass a Python object to the database as query argument you can use In order to pass a Python object to the database as query argument you can use
the `Json` adapter:: the `Json` adapter::
@ -553,7 +554,7 @@ the `Json` adapter::
curs.execute("insert into mytable (jsondata) values (%s)", curs.execute("insert into mytable (jsondata) values (%s)",
[Json({'a': 100})]) [Json({'a': 100})])
Reading from the database, |pgjson| and |jsonb| values will be automatically Reading from the database, |json| and |jsonb| values will be automatically
converted to Python objects. converted to Python objects.
.. note:: .. note::
@ -601,7 +602,7 @@ or you can subclass it overriding the `~Json.dumps()` method::
Customizing the conversion from PostgreSQL to Python can be done passing a Customizing the conversion from PostgreSQL to Python can be done passing a
custom `!loads()` function to `register_json()`. For the builtin data types custom `!loads()` function to `register_json()`. For the builtin data types
(|pgjson| from PostgreSQL 9.2, |jsonb| from PostgreSQL 9.4) use (|json| from PostgreSQL 9.2, |jsonb| from PostgreSQL 9.4) use
`register_default_json()` and `register_default_jsonb()`. For example, if you `register_default_json()` and `register_default_jsonb()`. For example, if you
want to convert the float values from :sql:`json` into want to convert the float values from :sql:`json` into
:py:class:`~decimal.Decimal` you can use:: :py:class:`~decimal.Decimal` you can use::