      
                                        
                     README: library ``PostgreSQL-OCaml''
                     ************************************
           Copyright   (C)   2004  Markus Mottl (*)  at OEFAI (#)  
           ========================================================
                          Vienna, January 29, 2004 
                          =========================
  

1  Directory contents
*=*=*=*=*=*=*=*=*=*=*

   
                                        
   -----------------------------------------------------------------------
   |        Changes          |           History of code changes         |
   -----------------------------------------------------------------------
   |        INSTALL          |        Short notes on compiling and       |
   |                         |           installing the library          |
   -----------------------------------------------------------------------
   |        LICENSE          |    ``GNU LESSER GENERAL PUBLIC LICENSE''  |
   -----------------------------------------------------------------------
   |        Makefile         |                Top Makefile               |
   -----------------------------------------------------------------------
   |     OCamlMakefile       |        Makefile for easy handling of      |
   |                         |         compilation of not so easy        |
   |                         |  OCaml-projects. It generates dependencies|
   |                         |        of OCaml-files automatically,      |
   |                         |      is able to handle ``ocamllex''-,     |
   |                         |    ``ocamlyacc''-, IDL- and C-files and   |
   |                         |       generates native- or byte-code      |
   |                         |        as executable or as library -      |
   |                         |      with thread-support if you want!     |
   -----------------------------------------------------------------------
   |         README          |                  This file                |
   -----------------------------------------------------------------------
   |        VERSION          |               Current version             |
   -----------------------------------------------------------------------
   |     examples/dump/      |           Dumps a table to stdout         |
   -----------------------------------------------------------------------
   |   examples/populate/    |        Inverse operation of ``dump''      |
   -----------------------------------------------------------------------
   |    examples/prompt/     |        A simple replacement for psql      |
   -----------------------------------------------------------------------
   |  examples/prompt_gtk/   |      Graphical version of ``prompt''.     |
   |                         |             Requires lablgtk!!!           |
   -----------------------------------------------------------------------
   |   examples/test_lo/     |   Demonstrates Large Objects manipulation |
   -----------------------------------------------------------------------
   |          lib/           |        OCaml-library for interfacing      |
   |                         |           the PostgreSQL-database         |
   -----------------------------------------------------------------------
                                        
  
  

2  What is the ``PostgreSQL-OCaml''-library?
*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=

  
  This OCaml-library provides an interface to PostgreSQL (tested with version
7.0.2, 7.1.3 and 7.4.1), an efficient and reliable, open source, relational
database. Almost all functionality available through the C-API (libpq) is
replicated in a type-safe way. This library uses objects for representing
database connections and results of queries.
  

3  How can you use it?
*=*=*=*=*=*=*=*=*=*=*=

  
  The interface is well-documented, and more detailed information on how to
interact with PostgreSQL is available from the PostgreSQL-website (1). The
examples in the examples-directory are mostly very short and comprehensible
and therefore a good way to get started.
  

4  Contact information
*=*=*=*=*=*=*=*=*=*=*=

  
  In the case of bugs, feature requests and similar, you can contact me here:
  
    markus@oefai.at
  
  Up-to-date information concerning this library should be available here:
  
    http://www.oefai.at/~markus/ocaml_sources
  
  Enjoy!!
  
--------------------------------------
  
 
 (*) http://www.oefai.at/~markus/
 
 (#) http://www.oefai.at
 
 (1) http://www.postgresql.org
-----------------------------------------------------------------------------
  
   
               This document was translated from LaTeX by HeVeA
               (http://pauillac.inria.fr/~maranget/hevea/index.html). 
