From b0472650fe2696fbb1ee0584189d1aefc5787186 Mon Sep 17 00:00:00 2001 From: brettwooldridge Date: Thu, 7 Nov 2013 17:51:50 +0900 Subject: [PATCH] Update README.md --- README.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/README.md b/README.md index ea5eb4fb..f864324e 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,35 @@ See benchmarks [here](https://github.com/brettwooldridge/HikariCP/wiki/Benchmark Or look at this: ![](http://github.com/brettwooldridge/HikariCP/wiki/50Connection_MixedBench.png) +------------------------------ +#### Driver Support #### +HikariCP has two modes of operation: *Delegation* and *Instrumentation*. *Instrumentation* is approximately 20-40% more +performant, but both are exceedingly fast. + +##### Delegation ##### +Delegation mode is supported for *all* JDBC drivers. + +##### Instrumentation ##### +Instrumentation mode is supported for specific JDBC drivers. If your favorite database is not supported, drop us a note +in the [Google group]() and we'll try to add support for it. Below is a table of drivers that are supported and their +status: + +| Driver | Version1 | Status | DataSource2 | +| ----------------- | --------------:| --------- | ------------ | +| Derby | 10.10.1.1 | Tested | org.apache.derby.jdbc.ClientDataSource40 | +| jTDS | 1.3.1 | Untested | net.sourceforge.jtds.jdbcx.JtdsDataSource | +| HSQLDB | 2.3.1 | Tested | org.hsqldb.jdbc.JDBCDataSource | +| MariaDB | 1.1.5 | Tested | org.mariadb.jdbc.MySQLDataSource | +| MySQL Connector/J | 5.1.56 | Tested | com.mysql.jdbc.jdbc2.optional.MysqlDataSource | +| Oracle | 12.1.0.1 | Untested | oracle.jdbc.pool.OracleDataSource | +| PostgreSQL | 9.2-1003.jdbc4 | Tested | org.postgresql.ds.PGSimpleDataSource | + +1Other driver versions for a given database will *probably* work, because class names are rarely changed. But +if it does not work, you will known quickly because HikariCP will likely fail to start. In this case, you can simply +force *delegation mode* (see properties below).
+2The *DataSource* is specified because it is by the specified DataSource name that HikariCP looks up the instrumentation +information in the internal codex. + ------------------------------ #### Configuration (knobs, baby!) ####