mirror of
https://github.com/psycopg/psycopg2.git
synced 2024-11-26 02:43:43 +03:00
Added docs about how to create a generic array typecaster
This commit is contained in:
parent
0c337a2029
commit
a165f86127
|
@ -325,6 +325,20 @@ details.
|
||||||
|
|
||||||
.. versionadded:: 2.4.3
|
.. versionadded:: 2.4.3
|
||||||
|
|
||||||
|
.. _cast-array-unknown:
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
|
||||||
|
The function can be used to create a generic array typecaster,
|
||||||
|
returning a list of strings: just use the `~psycopg2.STRING` as base
|
||||||
|
typecaster. For instance, if you want to receive from the database an
|
||||||
|
array of :sql:`macaddr`, each address represented by string, you can
|
||||||
|
use::
|
||||||
|
|
||||||
|
psycopg2.extensions.register_type(
|
||||||
|
psycopg2.extensions.new_array_type(
|
||||||
|
(1040,), 'MACADDR[]', psycopg2.STRING))
|
||||||
|
|
||||||
|
|
||||||
.. function:: register_type(obj [, scope])
|
.. function:: register_type(obj [, scope])
|
||||||
|
|
||||||
|
|
|
@ -109,6 +109,13 @@ Transferring binary data from PostgreSQL 9.0 doesn't work.
|
||||||
.. __: http://www.postgresql.org/docs/9.0/static/datatype-binary.html
|
.. __: http://www.postgresql.org/docs/9.0/static/datatype-binary.html
|
||||||
.. __: http://www.postgresql.org/docs/9.0/static/runtime-config-client.html#GUC-BYTEA-OUTPUT
|
.. __: http://www.postgresql.org/docs/9.0/static/runtime-config-client.html#GUC-BYTEA-OUTPUT
|
||||||
|
|
||||||
|
Arrays of *TYPE* are not casted to list.
|
||||||
|
Arrays are only casted to list when their oid is known, and an array
|
||||||
|
typecaster is registered for them. If there is no typecaster, the array is
|
||||||
|
returned unparsed from PostgreSQL (e.g. ``{a,b,c}``). It is easy to create
|
||||||
|
a generic arrays typecaster, returning a list of array: an example is
|
||||||
|
provided in the `~psycopg2.extensions.new_array_type()` documentation.
|
||||||
|
|
||||||
|
|
||||||
Best practices
|
Best practices
|
||||||
--------------
|
--------------
|
||||||
|
|
|
@ -294,7 +294,7 @@ the SQL string that would be sent to the database.
|
||||||
`bytea_output`__ configuration parameter to ``escape``, either in the
|
`bytea_output`__ configuration parameter to ``escape``, either in the
|
||||||
server configuration file or in the client session (using a query such as
|
server configuration file or in the client session (using a query such as
|
||||||
``SET bytea_output TO escape;``) before receiving binary data.
|
``SET bytea_output TO escape;``) before receiving binary data.
|
||||||
|
|
||||||
.. __: http://www.postgresql.org/docs/9.0/static/datatype-binary.html
|
.. __: http://www.postgresql.org/docs/9.0/static/datatype-binary.html
|
||||||
.. __: http://www.postgresql.org/docs/9.0/static/runtime-config-client.html#GUC-BYTEA-OUTPUT
|
.. __: http://www.postgresql.org/docs/9.0/static/runtime-config-client.html#GUC-BYTEA-OUTPUT
|
||||||
|
|
||||||
|
@ -334,6 +334,14 @@ the SQL string that would be sent to the database.
|
||||||
>>> cur.mogrify("SELECT %s;", ([10, 20, 30], ))
|
>>> cur.mogrify("SELECT %s;", ([10, 20, 30], ))
|
||||||
'SELECT ARRAY[10, 20, 30];'
|
'SELECT ARRAY[10, 20, 30];'
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
|
||||||
|
Reading back from PostgreSQL, arrays are converted to list of Python
|
||||||
|
objects as expected, but only if the types are known one. Arrays of
|
||||||
|
unknown types are returned as represented by the database (e.g.
|
||||||
|
``{a,b,c}``). You can easily create a typecaster for :ref:`array of
|
||||||
|
unknown types <cast-array-unknown>`.
|
||||||
|
|
||||||
.. _adapt-tuple:
|
.. _adapt-tuple:
|
||||||
|
|
||||||
.. index::
|
.. index::
|
||||||
|
|
Loading…
Reference in New Issue
Block a user