Typo fixes and improvements to new_array_type() docs

This commit is contained in:
Daniele Varrazzo 2013-10-21 15:26:57 +01:00
parent bc70902ea5
commit 6ab1ec1c37

View File

@ -352,8 +352,8 @@ details.
`register_type()` to be used. `register_type()` to be used.
:param oids: tuple of OIDs of the PostgreSQL type to convert. It should :param oids: tuple of OIDs of the PostgreSQL type to convert. It should
probably be the oid of the array type (e.g. the ``typarray`` field in probably contain the oid of the array type (e.g. the ``typarray``
the ``pg_type`` table. field in the ``pg_type`` table).
:param name: the name of the new type adapter. :param name: the name of the new type adapter.
:param base_caster: a Psycopg typecaster, e.g. created using the :param base_caster: a Psycopg typecaster, e.g. created using the
`new_type()` function. The caster should be able to parse a single `new_type()` function. The caster should be able to parse a single
@ -366,11 +366,12 @@ details.
.. note:: .. note::
The function can be used to create a generic array typecaster, The function can be used to create a generic array typecaster,
returning a list of strings: just use the `~psycopg2.STRING` as base returning a list of strings: just use `psycopg2.STRING` as base
typecaster. For instance, if you want to receive from the database an typecaster. For instance, if you want to receive an array of
array of :sql:`macaddr`, each address represented by string, you can :sql:`macaddr` from the database, each address represented by string,
use:: you can use::
# select typarray from pg_type where typname = 'macaddr' -> 1040
psycopg2.extensions.register_type( psycopg2.extensions.register_type(
psycopg2.extensions.new_array_type( psycopg2.extensions.new_array_type(
(1040,), 'MACADDR[]', psycopg2.STRING)) (1040,), 'MACADDR[]', psycopg2.STRING))