Changeset 423 for trunk/docs


Ignore:
Timestamp:
Dec 2, 2011, 12:12:01 PM (8 years ago)
Author:
darcy
Message:

In early November, 2011 the system housing PyGreSQL was hacked and wiped.
We lost the current repository. I restored an old backup copy of the
repository. This commit brings us back to the present.

Location:
trunk/docs
Files:
3 edited

Legend:

Unmodified
Added
Removed
  • trunk/docs/future.txt

    r409 r423  
    33==========================
    44
     5This list has been closed since tasks are now managed with the PyGreSQL
     6tracker that can be found at http://trac.vex.net:8000/pgtracker.
     7(ticket numbers have been added below):
    58
    69To Do
    710-----
    811
    9 - Documentation for the pgdb module (everything specific to PyGreSQL).
    10 - The large object and direct access functions need much more attention.
    11 - The fetch method should use real cursors.
     12- Add docs for the pgdb module (everything specific to PyGreSQL) (#5).
     13- The large object and direct access functions need much more attention (#6).
     14- The fetch method should use real cursors (#7).
    1215- The C module needs to be cleaned up and redundant code merged,
    13   and should get its own unit test module.
    14 - Clean up test_pg.py and merge it with TEST_PyGreSQL_classic.py.
     16  and should get its own unit test module (#8).
     17- Clean up test_pg.py and merge it with TEST_PyGreSQL_classic.py (#9).
    1518- The test suite for the classic module should also check that quoted
    1619  mixed-case identifiers can be used everywhere - currently they can't.
    17   Improve pg.py accordingly, adding quotes etc. as needed.
    18 - What shall we do with the "tutorial" directory
    19   (it's rather a tutorial for Postgres/SQL than for PyGreSQL,
    20   it's using only the query method from the classic pg module and
    21   no other PyGreSQL functionality, it's rather a demo than a tutorial)?
     20  Improve pg.py accordingly, adding quotes etc. as needed (#10).
     21- What shall we do with the "tutorial" directory - it's rather a tutorial
     22  for Postgres/SQL than for PyGreSQL, it's using only the query method from
     23  the classic pg module and no other PyGreSQL functionality, it's rather
     24  a demo than a tutorial (#11)?
    2225
    2326Proposed Patches
     
    2831  http://mailman.vex.net/pipermail/pygresql/2005-November/001530.html).
    2932  Maybe also make notifications accessible via the optional cursor and
    30   connection attribute "messages" proposed in the DB-API specs.
     33  connection attribute "messages" proposed in the DB-API specs (#12).
    3134
    3235Wish List
    3336---------
    3437
    35 - Make SQLSTATE error codes available.
    36 - Support the new listen/notify infrastructure of PostgreSQL 9.0.
     38- Make SQLSTATE error codes available (#13).
     39- Support the new listen/notify infrastructure of PostgreSQL 9.0 (#15).
    3740- Make use of PQexecParams() and PQprepare(). This could speed up
    3841  executemany() and allow retrieving binary data directly by setting
    39   the resultFormat parameter to one.
     42  the resultFormat parameter to one (#16).
    4043- Enhance cursor.description attribute, delivering more information
    41   available with PQfmod() or PQftable() for instance.
    42 - Support optional "errorhandler" extension.
    43 - Support optional cursor and connection attribute "messages".
    44 - Connection as context manager (see http://tinyurl.com/6j9cef).
    45 - Users should be able to register their own types with _pg.
     44  available with PQfmod() or PQftable() for instance (#17).
     45- Support optional "errorhandler" extension (#18).
     46- Support optional cursor and connection attribute "messages" (#19).
     47- Connection as context manager (see http://tinyurl.com/32bx6xo) (#20).
     48- Users should be able to register their own types with _pg (#21).
    4649- Let pg and pgdb support namedtuples (as available in Py 2.6).
    4750  pg could get a new method namedresult(), and pgdb could provide
    48   a row factory for namedtuples (similar to sqlite3).
     51  a row factory for namedtuples (similar to sqlite3) (#22).
    4952- New methods in the classic module, similar to getresult() and
    5053  dictresult(), but returning dictionaries of rows instead of lists
    51   of rows (with primary key or oids as keys).
    52 - Make PyGreSQL thread-safe on the connection level.
    53 - The API documentation could be created with Epydoc.
    54 - Write a tutorial for beginners and advanced use.
    55 - More and better documented examples.
     54  of rows (with primary key or oids as keys) (#23).
     55- Make PyGreSQL thread-safe on the connection level (#24).
     56- The API documentation could be created with Epydoc or Sphinx (#4).
     57- Write a tutorial for beginners and advanced use (#11).
     58- More and better documented examples (#4, #5, #11).
  • trunk/docs/index.html

    r419 r423  
    169169    <p>
    170170    Oleg Broytmann has written a simple example
    171     <a href="http://phd.pp.ru/Software/Python/#rgb_example">RGB
     171    <a href="http://phdru.name/Software/Python/#rgb_example">RGB
    172172    database demo</a>.
    173173    </p>
  • trunk/docs/pg.txt

    r393 r423  
    436436  :ValueError: empty SQL query or lost connection
    437437  :pg.ProgrammingError: error in query
    438   :pg.InternalError': error during query processing
     438  :pg.InternalError: error during query processing
    439439
    440440Description:
     
    575575  This method doesn't typecheck the fields according to the table definition;
    576576  it just look whether or not it knows how to handle such types.
     577
     578set_notice_receiver - set a custom notice receiver
     579--------------------------------------------------
     580Syntax::
     581
     582  set_notice_receiver(proc)
     583
     584Parameters:
     585  :proc: the custom notice receiver callback function
     586
     587Return type:
     588  None
     589
     590Exceptions raised:
     591  :TypeError: the specified notice receiver is not callable
     592
     593Description:
     594  This method allows setting a custom notice receiver callback function.
     595  When a notice or warning message is received from the server,
     596  or generated internally by libpq, and the message level is below
     597  the one set with `client_min_messages`, the specified notice receiver
     598  function will be called. This function must take one parameter,
     599  the `pgnotice` object, which provides the following read-only attributes:
     600
     601    :pgcnx: the connection
     602    :message: the full message with a trailing newline
     603    :severity: the level of the message, e.g. 'NOTICE' or 'WARNING'
     604    :primary: the primary human-readable error message
     605    :detail: an optional secondary error message
     606    :hint: an optional suggestion what to do about the problem
     607
     608get_notice_receiver - get the current notice receiver
     609-----------------------------------------------------
     610Syntax::
     611
     612  get_notice_receiver()
     613
     614Parameters:
     615  None
     616
     617Return type:
     618  :callable, None: the current notice receiver callable
     619
     620Exceptions raised:
     621  :TypeError: too many (any) arguments
     622
     623Description:
     624  This method gets the custom notice receiver callback function that has
     625  been set with `set_notice_receiver()`, or `None` if no custom notice
     626  receiver has ever been set on the connection.
    577627
    578628putline - writes a line to the server socket [DA]
     
    912962  you can overcome this problem by simply adding an index onto the OID of
    913963  any table that you think may get large over time. You may also consider
    914   using the inserttable() method described in section 3. 
     964  using the inserttable() method described in section 3.
    915965
    916966  Note: With PostgreSQL versions before 8.2 the table being inserted to
Note: See TracChangeset for help on using the changeset viewer.