source: branches/4.x/docs/pgdb.txt @ 671

Last change on this file since 671 was 671, checked in by cito, 4 years ago

Convert pg module documentation to Sphinx

The documentation was already written in reST format, but did not use
Sphinx specific features for documenting the various Python objects.

  • Property svn:keywords set to Author Date Id Revision
File size: 1.0 KB
Line 
1----------------------------------------------
2:mod:`pgdb` --- The DB-API Compliant Interface
3----------------------------------------------
4
5.. module:: pgdb
6
7.. contents:: Contents
8
9
10Introduction
11============
12You may either choose to use the "classic" PyGreSQL interface
13provided by the :mod:`pg` module or else the
14DB-API 2.0 compliant interface provided by the :mod:`pgdb` module.
15
16`DB-API 2.0 <http://www.python.org/dev/peps/pep-0249/>`_
17(Python Database API Specification v2.0)
18is a specification for connecting to databases (not only PostGreSQL)
19from Python that has been developed by the Python DB-SIG in 1999.
20
21The following documentation covers only the newer :mod:`pgdb` API.
22
23The authoritative programming information for the DB-API is :pep:`0249`
24
25A useful tutorial-like `introduction to the DB-API
26<http://www2.linuxjournal.com/lj-issues/issue49/2605.html>`_
27has been written by Andrew M. Kuchling for the LINUX Journal in 1998.
28
29
30The pgdb module
31===============
32
33.. note::
34
35   **TO DO**: This section of the documentation still needs to be written.
36
Note: See TracBrowser for help on using the repository browser.