Connectivity Drivers Source Code

From Ingres Community Wiki

This document explains where to obtain and how to download the Ingres driver code for Ruby and Python. For information on getting the source for JDBC, .NET, ODBC, Perl and PHP please see the following links:

• JDBC - http://community.ingres.com/wiki/Ingres_JDBC_Learn
• Microsoft .NET - http://community.ingres.com/wiki/Ingres_DOT_NET_Learn
• ODBC - http://community.ingres.com/wiki/Ingres_ODBC_Learn
• Perl http://community.ingres.com/wiki/Ingres_Perl_Learn
• PHP - http://community.ingres.com/wiki/Ingres_PHP_Learn

Downloading the source code

The source code for the Ingres Ruby and Python drivers is kept in a Subversion repository at http://code.ingres.com. In order to download the source you will need an SVN client. Below is a list of some of the clients available for working with Subversion

• Windows - TortoiseSVN - http://tortoisesvn.tigris.org/
• Linux - "subversion" package for your distribution
• Unix - Build from sources http://subversion.tigris.org/
• OS X
  • Subversion from http://www.macports.org
  • Versions from http://www.versionsapp.com/

To download the source you need to specify one of the following URLs when performing a checkout:

• Python - http://code.ingres.com/ingres/drivers/python/
• Ruby - http://code.ingres.com/ingres/drivers/ruby/

For example if using the command line Subversion client 'svn' the following will check out all the code for Python:

 svn co http://code.ingres.com/ingres/drivers/python/

This will download the complete tree for the Python driver into the directory 'python'. If you are only interested in the 'main' code line use the following command:

 svn co http://code.ingres.com/ingres/drivers/python/main/ ingresdbi-main

Note that an additional parameter of 'ingresdbi-main' has been specified. The code for http://code.ingres.com/ingres/drivers/python/main/ will be extracted in to this directory. Otherwise the checkout will download the code into a directory named 'main'.

Code Layout

Each driver contains the following directories:

 branches/
 main/
 tags/

Branches

The branches directory is used for creating forks in the driver code. For example there may come a time when a new release of Ruby or Python that require changes in the driver code which break backwards compatibility with earlier releases of the driver. Alternatively branches can be used to introduce major new functionality in the driver allowing the developers to distinguish between major releases of the code. Typically only bug fixes go in to the branches directories unless a branch has been made to work on some experimental code that could de-stabilize the main code line.

Main

Main is the Ingres name assigned to the development code-line. Those familiar with other development systems would probably know it as either HEAD (CVS) or trunk (Subversion). All current development work related to new features will occur here unless new work has the potential to de-stabilize the main code line.

Tags

When a release of a driver is made available for download on http://ingres.com/downloads/connectivity-resources.php a tag is created of all files in that release. This allows us to see what files were in a particular release and track the potential differences between releases should any problems occur.

Committing changes to the code

The code is freely available to download however to submit changes back in to http://code.ingres.com you will need commit access rights for the driver you are submitting code for.

To get commit access you will need an Ingres Community account. If you do not already have an account you can register at http://www.ingres.com/users/register.php. Once you have a Community account please raise a ticket at http://bugs.ingres.com/ specifying why you need access and which driver you need access for. Access is only given to people who have proved they can provide reliable changes to the code. Should you not get a timely response please email community (dot) drivers (at) ingres (dot) com, including a reference to the ticket number raised.

Building the drivers

Each driver comes with a README/README.html file that outlines the pre-requisites and the steps needed to build the driver.

Where to find more information

Additional information about the Ingres connectivity drivers and Ingres in general can be found via the Ingres Community wiki, http://community.ingres.com/wiki/Ingres_Connectivity_Home The Ingres community forums, http://community.ingres.com/forums, can be used to discuss Ingres connectivity drivers. Alternatively there is a long established newsgroup (USENET), comp.databases.ingres. See http://www.rationalcommerce.com/community.htm for information on how to get access. If you want to chat directly with Ingres users and staff you can log on to the #ingres channel on irc.freenode.net. If all else fails please feel free to email community (dot) drivers (at) ingres (dot) com.

Revision - $Revision: 84 $ Last Updated $Date: 2008-06-09 14:51:07 +0200 (Mon, 09 Jun 2008) $ by $Author: grant $