timwee / jdbi Goto Github PK

jDBI provides a convenience interface for SQL operations in Java. It is not 
intended as an abstraction layer, but rather a library which makes the common 
things easy and the hard things possible, to paraphrase Larry Wall.

The primary entry point for using jDBI is the DBI class. This is used to create
Handle instances, each of which represents a connection to the RDBMS. A Handle 
wraps a JDBC Connection instance, and makes use of that same Connection for all 
of its operations.

Generally, you will explicitely create statements, queries, and batch 
operations for working with data in the database. Seperate objects are used to
represent these things, and they are designed to be used in a somewhat 
literate-programming style. Here is an example:

  DBI dbi = new DBI("jdbc:derby:testing");
  Handle handle = dbi.open();
  Query<Something> query = handle.createQuery("select * from something where name like :name")
                                 .bind("name", "Eri%")
                                 .map(Something.class);
  List<Something> rs = query.list();
  handle.close();


INSTALLATION

Building requires Apache Ant ( http://ant.apache.org/ )

If ant complains that it cannot find the JUnit task, copy
the junit-3.8.1.jar into the $ANT_HOME/lib directory, or into
$HOME/.ant/lib and try again.

To build the runtime library, use "ant jar"

    This will produce a jdbi-<version>.jar in the build/ directory

    There are no library dependencies for jDBI

To run the unit/regression test suite use "ant test"

    Test report will be in the report/ directory

    The test suite requires the libraries in the lib/test/ directory
    and uses the Apache Derby ( http://www.apache.org/ ) embedded
    database for its tests.