Changeset 636


Ignore:
Timestamp:
Nov 26, 2015, 2:23:44 PM (4 years ago)
Author:
cito
Message:

Clean up the docs

We had used .txt for the old docs and .rst for the new Sphinx docs,
which unfortunately got out of sync. I have merged the duplicates,
keeping the latest version of the text, and left them only as .txt
files for the time being until we give Sphinx another go.

The index file is not auto generated - the index.rst file is only
a reminder that we want to move everything to Sphinx.

Files:
10 deleted
5 edited
12 moved

Legend:

Unmodified
Added
Removed
  • branches/4.x/docs

    • Property svn:ignore
      •  

        old new  
         1*.html
         2_build
        13announce.html
        24changelog.html
         
        68pgdb.html
        79readme.html
        8 _build
  • branches/4.x/docs/changelog.txt

    r635 r636  
    2424------------------------
    2525- Dropped support for Python below 2.5 and PostgreSQL below 8.3.
    26 - Support the new PostgreSQL versions 9.0, 9.1 and 9.2.
     26- Added support for Python up to 2.7 and PostgreSQL up to 9.2.
    2727- Particularly, support PQescapeLiteral() and PQescapeIdentifier().
    2828- The query method of the classic API now supports positional parameters.
     
    3232  getresult() and dictresult(), which returns the rows of the result
    3333  as named tuples if these are supported (Python 2.6 or higher).
     34- The classic API has got the new methods begin(), commit(), rollback(),
     35  savepoint() and release() for handling transactions.
     36- Both classic and DBAPI 2 connections can now be used as context
     37  managers for encapsulating transactions.
    3438- The execute() and executemany() methods now return the cursor object,
    3539  so you can now write statements like "for row in cursor.execute(...)"
  • branches/4.x/docs/classic.txt

    r635 r636  
    590590
    591591Description:
    592   This methods try to get a notify from the server (from the SQL statement
     592  This method tries to get a notify from the server (from the SQL statement
    593593  NOTIFY). If the server returns no notify, the methods returns None.
    594594  Otherwise, it returns a tuple (triplet) `(relname, pid, extra)`, where
     
    814814Description:
    815815  This methods allows to create large objects in a very simple way. You just
    816   give the name of a file containing the data to be use.
     816  give the name of a file containing the data to be used.
    817817
    818818Object attributes
  • branches/4.x/docs/future.txt

    r635 r636  
    1010
    1111- Add docs for the pgdb module (everything specific to PyGreSQL) (#5).
    12 - The large object and direct access functions need much more attention (#6).
    1312- The fetch method should use real cursors (#7).
    1413- The C module needs to be cleaned up and redundant code merged,
    1514  and should get its own unit test module (#8).
    16 - Clean up test_pg.py and merge it with TEST_PyGreSQL_classic.py (#9).
    1715- The test suite for the classic module should also check that quoted
    1816  mixed-case identifiers can be used everywhere - currently they can't.
     
    2624----------------
    2725
    28 - Notice handling with PQsetNoticeReceiver and PQsetNoticeProcessor
    29   (one possible implementation was already suggested by Dmitry Dvoinikov
    30   https://mail.vex.net/mailman/private.cgi/pygresql/2005-November/001530.html).
    31   Maybe also make notifications accessible via the optional cursor and
    32   connection attribute "messages" proposed in the DB-API specs (#12).
     26- Support for asynchronous command processing (#49).
    3327
    3428Wish List
    3529---------
    3630
    37 - Make SQLSTATE error codes available (#13).
    38 - Support the new listen/notify infrastructure of PostgreSQL 9.0 (#15).
    3931- Make use of PQexecParams() and PQprepare(). This could speed up
    4032  executemany() and allow retrieving binary data directly by setting
     
    4436- Support optional "errorhandler" extension (#18).
    4537- Support optional cursor and connection attribute "messages" (#19).
    46 - Connection as context manager (see http://tinyurl.com/32bx6xo) (#20).
    4738- Users should be able to register their own types with _pg (#21).
    48 - Let pg and pgdb support namedtuples (as available in Py 2.6).
    49   pg could get a new method namedresult(), and pgdb could provide
    50   a row factory for namedtuples (similar to sqlite3) (#22).
     39- pg has now got a new method namedresult() that returns named tuples.
     40  pgdb should also support named tuples, maybe via a row_factory attribute
     41  on the connection, similar to sqlite3 (see #22).
    5142- New methods in the classic module, similar to getresult() and
    5243  dictresult(), but returning dictionaries of rows instead of lists
  • branches/4.x/docs/pg.txt

    r563 r636  
    385385  used by PyGreSQL to hold PostgreSQL numeric values. The default class
    386386  is decimal.Decimal if available, otherwise the float type is used.
    387  
     387
    388388set_namedresult -- set a function that will convert to named tuples
    389389-------------------------------------------------------------------
     
    397397Description:
    398398  You can use this if you want to create different kinds of named tuples.
    399  
     399
    400400
    401401Module constants
  • trunk/docs/changelog.txt

    r516 r636  
    1 ==================
    2 PyGreSQL ChangeLog
    3 ==================
     1ChangeLog
     2=========
    43
    54Version 4.2
    65-----------
     6- Set a better default for the user option "escaping-funcs".
     7- Greatly improve unit testing.
     8- Force build to compile with no errors.
     9- Fix decimal point handling
     10- Add option to return money as string
     11- Fix notification handler (Thanks Patrick TJ McPhee).
    712
    813Version 4.1.1 (2013-01-08)
     
    4348- Better support for notice processing with the new methods
    4449  set_notice_receiver() and get_notice_receiver()
    45   (as suggested by Michael Filonenko, see #12 and #37).
     50  (as suggested by Michael Filonenko, see #37).
    4651- Open transactions are rolled back when pgdb connections are closed
    4752  (as suggested by Peter Harris, see #46).
     
    5560------------------------
    5661- Dropped support for Python below 2.3 and PostgreSQL below 7.4.
    57 - Added support for Python up to 2.6 and PostgreSQL up to 8.3.
    5862- Improved performance of fetchall() for large result sets
    5963  by speeding up the type casts (as suggested by Peter Schuller).
  • trunk/docs/future.txt

    r626 r636  
    1 ==========================
    21PyGreSQL future directions
    32==========================
     
    1413- The C module needs to be cleaned up and redundant code merged,
    1514  and should get its own unit test module (#8).
    16 - Clean up test_pg.py and merge it with TEST_PyGreSQL_classic.py (#9).
    1715- The test suite for the classic module should also check that quoted
    1816  mixed-case identifiers can be used everywhere - currently they can't.
     
    2220  the classic pg module and no other PyGreSQL functionality, it's rather
    2321  a demo than a tutorial (#11)?
     22
     23Proposed Patches
     24----------------
     25
     26- Support for asynchronous command processing (#49).
    2427
    2528Wish List
  • trunk/docs/install.txt

    r553 r636  
    1 =====================
    2 PyGreSQL Installation
    3 =====================
    4 
    5 .. sectnum::
    6 .. contents:: Contents
    7 
     1Installation
     2============
    83
    94General
    10 =======
     5-------
    116
    127You must first have installed Python and PostgreSQL on your system.
     
    1611``PATH`` environment variable.
    1712
    18 The current version of PyGreSQL has been tested with Python 2.7 and
    19 PostGreSQL 9.4. Older version should work as well, but you will need
    20 at least Python 2.6 and PostgreSQL 9.0.
     13The current version of PyGreSQL has been tested with Python versions
     142.7, 3.4 and PostGreSQL version 9.4. Older version should work as well,
     15but you will need at least Python 2.6 and PostgreSQL 9.0.
    2116
    2217PyGreSQL will be installed as three modules, a dynamic module called
     
    2722
    2823Installing from a Binary Distribution
    29 =====================================
     24-------------------------------------
    3025
    3126This is the easiest way to install PyGreSQL.
     
    4136
    4237Installing from Source
    43 ======================
     38----------------------
    4439
    4540If you want to install PyGreSQL from Source, or there is no binary
Note: See TracChangeset for help on using the changeset viewer.