GREAT-ER DB API Wrapper generator
=================================

Building with cmake
-------------------
An alternative to using setup.py is building the greater db api with
cmake.

A basic way without special paths or options could be:

mkdir build
cd build
cmake ..
make
sudo make install


setup.py
--------

The wrapper code is created and built by the setup.py script in the
top-level directory. Note that the wrapper (and the API) can be build 
for two databases, Oracle and PostgreSQL. You have to supply one of the 
following four options depending on database and available API sources:
	--orcle-interface-lib <path>
	--oracle-interface-file <path>
	--postgres-interface-lib <path>
	--postgres-interface-file <path>
If you are building an interface file with PostgreSQL you can specify 
the library and include paths supplying the options 
--postgres-lib-path and --postgres-incl-path.

Additional options:
		--wrapper-with-debug-output


Usage
-----

After running "setup.py build" the python DB api is in the GreaterDB
subdirectory. This directoy is a Python package, so put its parent
directory into Python's path (e.g. by setting the PYTHONPATH environment
variable) or by copying it to some suitable location.

The public interface of the API wrapper is GreaterDB.interface. Before
you can call any of the DB-API functions in the module, call
GreaterDB.interface.set_api_interface( <API-Wrapper> ) to initialize the
low-level interface, either

	GreaterDB.interface.set_api_interface("_dagreater")	for Oracle or
	GreaterDB.interface.set_api_interface("_dagreater_pg")	for PostgreSQL.

	
Tools
-----

The two scripts in the tools/ subdirectory, parse_function_proto.py and
parse_struct_spec.py, are helper programs to make creating the
apispec.py file easier. They parse function prototypes and struct
declarations and print code that can be pasted into dbapi/apispec.py.