RimuDB Logo
Database Access Framework for Java

Installation

Requirements

RimuDB and the RimuDB Editor is written in 100% Java and will run on any Java compatible platform, RimuDB requires at least JDK 1.5.

RimuDB has some dependant 3rd party open source jar files. These are included in the distribution.

You will need a JDBC driver to access the database(s) you intend to connect to.

Setup

Download the zip file from the builds page.

Create a new directory and unzip the files into this directory. The following files will be unzipped:

  • rimudb-x.y.z.jar
  • rimudb-editor-x.y.z.jar
  • commons-logging-1.1.jar
  • c3p0-0.9.1.2.jar
  • wizard.jar
  • rimudbeditor.bat
  • rimudb-javadoc-x.y.z.zip

Using the Editor

If you plan to create table descriptors by importing the table definition from a database, you will also need your database's jdbc driver jar file in the same directory.

Execute the windows bat file (rimudbeditor.bat) to start the editor.

Note that when the editor is started, it attempts to build a classpath from all the jar files it finds in the directory (or sub-directories). It then attempts to find all the JDBC drivers in this classpath. If the zip file was unzipped into a directory with a large number of jar files, discovery of JDBC drivers can take a long time. To avoid this, create a new directory for rimudb and unzip there.

Running your Application

To run your application, you will need the following jar files in the classpath:

  • rimudb-x.y.z.jar
  • c3p0-0.9.1.2.jar
  • commons-logging-1.1.jar

In order to access your database, you will also need your database's jdbc driver jar file in your classpath.

Connection Pool

The C3P0 connection pool seems to work the best, and so this jar file is included with in the RimuDB zip file package.

If you are using RimuDB within a container (i.e. a Servlet or a Spring application), RimuDB can use the container's connection pool via JNDI. No additional jar files are required for JNDI connections. You only need the following jar files in your classpath:

  • rimudb-x.y.z.jar
  • commons-logging-1.1.jar

RimuDB will also work with Apache DBCP, although based upon some limited testing this doesn't seem to be a very reliable connection pool. If you really want to use Apache DBCP then download the following:

From http://commons.apache.org/dbcp/, download the distribution for JDBC 3: commons-dbcp-1.3-bin.zip. Then extract the jar file commons-dbcp-1.3.jar. Do not download the distribution for JDBC 4.

From http://commons.apache.org/pool/, download the distribution for JDBC 3: commons-pool-1.5.4-bin.zip. Then extract the jar file commons-pool-1.5.4.jar. Do not download the distribution for JDBC 4.

Put both of these jar files in the classpath of your application.