Bind automatically JDBC Connection URL and Driver

For those users (like me!!!) don't have a dictionary to quickly retrieve the JDBC url pattern and the driver class name for a specific DBMS, here it comes the org.mybatis.guice.datasource.helper.JdbcHelper Module.

It is an easy to use Google Guice module that makes easy the JDBC.url and JDBC.driver properties binding needed for the DataSource providers.

The org.mybatis.guice.datasource.helper.JdbcHelper provides a large number of Enumeration values that cover the most popular DBMS (both commercial and open source) that are provided/recommended by the actual database vendor, resumed in the table below.

Variable Format Patterns contain variables in the Apache ANT alike style, in the format ${name|defaultValue}, where name is used as label which will looked for in the current Guice Injector, with defaultValue as its default value, replaced in the pattern if name is not found.

NOTE this feature doesn't work with XML Module!!!

Supported DBMS

Usage Example

Using the helper is simpler than explain how it works, let's have a look at the code below that configures the PooledDataSourceProvider for MySQL:

final Properties myBatisProperties = new Properties();
myBatisProperties.setProperty("mybatis.environment.id", "test");
// configure the database host
myBatisProperties.setProperty("JDBC.host", "contacts.acme.db");
// configure the database port
myBatisProperties.setProperty("JDBC.port", "6969");
// configure the database schema
myBatisProperties.setProperty("JDBC.schema", "contacts_test");
myBatisProperties.setProperty("JDBC.username", "fooTest");
myBatisProperties.setProperty("JDBC.password", "barPWD");
myBatisProperties.setProperty("JDBC.autoCommit", "false");
// binds the JDBC connection URL and the Driver class name for MySQL
Injector injector = Guice.createInjector(JdbcHelper.MySQL,
    new MyBatisModule() {
        public void configure(Binder binder) {
            setDataSourceProviderType(PooledDataSourceProvider.class);
            addSimpleAliases(Contact.class);
            addMapperClasses(ContactMapper.class);
        }
    },
    new Module() {
        public void configure(Binder binder) {
            /* binds the properties configuration; JDBC.host,
             * JDBC.port and JDBC.schema will be used to be
             * replaced in the URL Pattern
             */
            Names.bindProperties(binder, myBatisProperties);
        }
    });