psycopg/psycopg2
1
1
Fork 0
mirror of https://github.com/psycopg/psycopg2.git synced 2024-11-23 01:16:34 +03:00
Code Issues Packages Projects Releases Wiki Activity

Fixed jumbled COPY methods.

Browse Source
This commit is contained in:
Daniele Varrazzo 2010-02-10 00:10:51 +00:00 committed by Federico Di Gregorio
parent 6199ce5127
commit c176a9d075
2 changed files with 25 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
doc/cursor.rst
View File

@ -419,7 +419,15 @@ The ``cursor`` class
Read data *from* the file-like object :obj:`file` appending them to Read data *from* the file-like object :obj:`file` appending them to
the table named :obj:`table`. :obj:`file` must have both ``read()`` the table named :obj:`table`. :obj:`file` must have both ``read()``
and ``readline()`` method. See :ref:`copy` for an overview. :: and ``readline()`` method. See :ref:`copy` for an overview.
The optional argument :obj:`sep` is the columns separator and
:obj:`null` represents ``NULL`` values in the file.
The :obj:`columns` argument is a sequence containing the name of the
fields where the read data will be entered. Its length and column
type should match the content of the read file. If not specifies, it
is assumed that the entire table matches the file structure. ::
>>> f = StringIO("42\tfoo\n74\tbar\n") >>> f = StringIO("42\tfoo\n74\tbar\n")
>>> cur.copy_from(f, 'test', columns=('num', 'data')) >>> cur.copy_from(f, 'test', columns=('num', 'data'))
@ -428,12 +436,6 @@ The ``cursor`` class
>>> cur.fetchall() >>> cur.fetchall()
[(7, 42, 'foo'), (8, 74, 'bar')] [(7, 42, 'foo'), (8, 74, 'bar')]
The optional argument :obj:`sep` is the columns separator and
:obj:`null` represents ``NULL`` values in the file.
The :obj:`columns` argument is a sequence of field names: if not
``None`` only the specified fields will be included in the dump.
.. versionchanged:: 2.0.6 .. versionchanged:: 2.0.6
added the :obj:`columns` parameter. added the :obj:`columns` parameter.
@ -441,18 +443,17 @@ The ``cursor`` class
.. method:: copy_to(file, table, sep='\\t', null='\\N', columns=None) .. method:: copy_to(file, table, sep='\\t', null='\\N', columns=None)
Write the content of the table named :obj:`table` *to* the file-like object :obj:`file`. :obj:`file` must have a ``write()`` method. See Write the content of the table named :obj:`table` *to* the file-like object :obj:`file`. :obj:`file` must have a ``write()`` method. See
:ref:`copy` for an overview. :: :ref:`copy` for an overview.
>>> cur.copy_to(sys.stdout, 'test', sep="|")
1|100|abc'def
2|\N|dada
The optional argument :obj:`sep` is the columns separator and The optional argument :obj:`sep` is the columns separator and
:obj:`null` represents ``NULL`` values in the file. :obj:`null` represents ``NULL`` values in the file.
The :obj:`columns` argument is a sequence representing the fields The :obj:`columns` argument is a sequence of field names: if not
where the read data will be entered. Its length and column type should ``None`` only the specified fields will be included in the dump. ::
match the content of the read file.
>>> cur.copy_to(sys.stdout, 'test', sep="|")
1|100|abc'def
2|\N|dada
.. versionchanged:: 2.0.6 .. versionchanged:: 2.0.6
added the :obj:`columns` parameter. added the :obj:`columns` parameter.
@ -464,16 +465,16 @@ The ``cursor`` class
handle all the parameters that PostgreSQL makes available (see handle all the parameters that PostgreSQL makes available (see
|COPY|__ command documentation). |COPY|__ command documentation).
:obj:`file` must be an open, readable file for ``COPY FROM`` or an
open, writeable file for ``COPY TO``. The optional :obj:`size`
argument, when specified for a ``COPY FROM`` statement, will be passed
to file's read method to control the read buffer size. ::
>>> cur.copy_expert("COPY test TO STDOUT WITH CSV HEADER", sys.stdout) >>> cur.copy_expert("COPY test TO STDOUT WITH CSV HEADER", sys.stdout)
id,num,data id,num,data
1,100,abc'def 1,100,abc'def
2,,dada 2,,dada
:obj:`file` must be an open, readable file for ``COPY FROM`` or an
open, writeable file for ``COPY TO``. The optional :obj:`size`
argument, when specified for a ``COPY FROM`` statement, will be passed
to file's read method to control the read buffer size.
.. |COPY| replace:: ``COPY`` .. |COPY| replace:: ``COPY``
.. __: http://www.postgresql.org/docs/8.4/static/sql-copy.html .. __: http://www.postgresql.org/docs/8.4/static/sql-copy.html

8
doc/usage.rst
View File

@ -371,15 +371,15 @@ Psycopg :class:`cursor` objects provide an interface to the efficient
PostgreSQL |COPY|__ command to move data from files to tables and back. PostgreSQL |COPY|__ command to move data from files to tables and back.
The methods exposed are: The methods exposed are:
:meth:`cursor.copy_to()`
Writes the content of a table *to* a file-like object (``COPY table TO
file`` syntax). The target file must have a ``write()`` method.
:meth:`cursor.copy_from()` :meth:`cursor.copy_from()`
Reads data *from* a file-like object appending them to a database table Reads data *from* a file-like object appending them to a database table
(``COPY table FROM file`` syntax). The source file must have both (``COPY table FROM file`` syntax). The source file must have both
``read()`` and ``readline()`` method. ``read()`` and ``readline()`` method.
:meth:`cursor.copy_to()`
Writes the content of a table *to* a file-like object (``COPY table TO
file`` syntax). The target file must have a ``write()`` method.
:meth:`cursor.copy_expert()` :meth:`cursor.copy_expert()`
Allows to handle more specific cases and to use all the |COPY| features Allows to handle more specific cases and to use all the |COPY| features
available in PostgreSQL. available in PostgreSQL.