summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/00_index.mkd1
-rw-r--r--docs/02_usage.mkd20
-rw-r--r--docs/03_performance.mkd6
-rw-r--r--docs/05_building.mkd4
-rw-r--r--docs/05_releases.mkd7
5 files changed, 27 insertions, 11 deletions
diff --git a/docs/00_index.mkd b/docs/00_index.mkd
index daf9c42..ea5df61 100644
--- a/docs/00_index.mkd
+++ b/docs/00_index.mkd
@@ -40,6 +40,7 @@ select * from products
- [HSQLDB](http://hsqldb.org) 2.2.4
- [Derby](http://db.apache.org/derby) 10.7.1.1 & 10.8.1.2
- [MySQL](http://mysql.com) 5.0.51b
+- [PostgreSQL](http://postgresql.org) 9.0
Support for others is possible and may only require creating a simple "dialect" class.
diff --git a/docs/02_usage.mkd b/docs/02_usage.mkd
index 31dbfb6..14619f2 100644
--- a/docs/02_usage.mkd
+++ b/docs/02_usage.mkd
@@ -97,33 +97,33 @@ Iciql does not throw any [checked exceptions](http://en.wikipedia.org/wiki/Excep
### Statement Logging
-Iciql provides a mechanism to log generated statements to the console, to SLF4J, or to your own logging framework. Exceptions are not logged using this mechanism; exceptions are wrapped and rethrown as `IciqlException`, which is a RuntimeException.
+Iciql provides a mechanism to log generated statements and warnings to the console, to SLF4J, or to your own logging framework. Exceptions are not logged using this mechanism; exceptions are wrapped and rethrown as `IciqlException`, which is a RuntimeException.
#### Console Logging
%BEGINCODE%
-StatmentLogger.activeConsoleLogger();
-StatmentLogger.deactiveConsoleLogger();
+IciqlLogger.activeConsoleLogger();
+IciqlLogger.deactiveConsoleLogger();
%ENDCODE%
#### SLF4J Logging
%BEGINCODE%
-Slf4jStatementListener slf4j = new Slf4jStatementListener();
+Slf4jIciqlListener slf4j = new Slf4jIciqlListener();
slf4j.setLevel(StatementType.CREATE, Level.WARN);
slf4j.setLevel(StatementType.DELETE, Level.WARN);
slf4j.setLevel(StatementType.MERGE, Level.OFF);
-StatmentLogger.registerListener(slf4j);
-StatmentLogger.unregisterListener(slf4j);
+IciqlLogger.registerListener(slf4j);
+IciqlLogger.unregisterListener(slf4j);
%ENDCODE%
#### Custom Logging
%BEGINCODE%
-StatementListener custom = new StatementListener() {
- public void logStatement(StatementType type, String statement) {
+IciqlListener custom = new IciqlListener() {
+ public void logIciql(StatementType type, String statement) {
// do log
}
};
-StatmentLogger.registerListener(custom);
-StatmentLogger.unregisterListener(custom);
+IciqlLogger.registerListener(custom);
+IciqlLogger.unregisterListener(custom);
%ENDCODE%
## Understanding Aliases and Model Classes
diff --git a/docs/03_performance.mkd b/docs/03_performance.mkd
index 7df050a..12c07a1 100644
--- a/docs/03_performance.mkd
+++ b/docs/03_performance.mkd
@@ -9,7 +9,11 @@ Performance of iciql statement generation is not currently benchmarked.
### iciql+database performance comparison
-The following data was generated by running the iciql test suite. The suite is almost completely single-threaded. All Java databases are run in embedded *memory-only* mode through a JDBC connection.
+The following data was generated by running the *single-threaded* iciql test suite. All database connections are pooled and re-used within each execution of the test suite using [Apache Commons DBCP](http://commons.apache.org/dbcp).
+
+Connections are pooled to normalize embedded database performance with out-of-process database performance. Some of the Java embedded database configurations have a very high startup-time penalty. Notably, H2 is slow to open a database and its performance is substantially affected if connection pooling is not enabled to keep the embedded database open.
+
+All performance numbers include the combined overhead of iciql statement generation and JUnit 4 test framework execution so they are not bare-metal database metrics.
<pre>
%DBPERFORMANCE%
diff --git a/docs/05_building.mkd b/docs/05_building.mkd
index 8a4f45b..0025279 100644
--- a/docs/05_building.mkd
+++ b/docs/05_building.mkd
@@ -11,12 +11,16 @@ Additionally, [eclipse-cs](http://eclipse-cs.sourceforge.net), [FindBugs](http:/
- [H2 Database](http://h2database.com) (Eclipse Public License 1.0)
- [HSQL Database Engine](http://hsqldb.org) (BSD)
- [Apache Derby Database](http://db.apache.org/derby) (Apache 2.0)
+- [MySQL Connector/J](http://dev.mysql.com/downloads/connector/j) (GPL)
+- [PostgreSQL JDBC Connector](http://jdbc.postgresql.org) (BSD)
- [JUnit](http://junit.org) (Common Public License)
- [commons-net](http://commons.apache.org/net) (Apache 2.0)
- [ant-googlecode](http://code.google.com/p/ant-googlecode) (New BSD)
- [MarkdownPapers](http://markdown.tautua.org) (Apache 2.0)
- [doclava](http://code.google.com/p/doclava) (Apache 2.0)
- [SLF4J](http://www.slf4j.org) (MIT/X11)
+- [Apache Commons Pool](http://commons.apache.org/pool) (Apache 2.0)
+- [Apache Commons DBCP](http://commons.apache.org/dbcp) (Apache 2.0)
### Instructions
1. Clone the git repository from [GoogleCode][iciqlsrc].
diff --git a/docs/05_releases.mkd b/docs/05_releases.mkd
index 8e0dfd6..bd3c853 100644
--- a/docs/05_releases.mkd
+++ b/docs/05_releases.mkd
@@ -6,13 +6,20 @@
**%VERSION%** ([zip](http://code.google.com/p/iciql/downloads/detail?name=%ZIP%)|[jar](http://code.google.com/p/iciql/downloads/detail?name=%JAR%)) &nbsp; *released %BUILDDATE%*
+- api change release (API v6)
- Finished MySQL dialect implementation. MySQL 5.0.51b passes 100% of tests.
+- Added PostgreSQL dialect. PostgreSQL 9.0 passes all but the boolean-as-int tests.
- Added Db.dropTable(T) method
+- Overhauled test suite and included more database configurations.
+- Renamed StatementLogger to IciqlLogger
+- Added IciqlLogger.warn method
+- Added IciqlLogger.drop method
### Older Releases
**0.6.6** &nbsp; *released 2011-08-15*
+- api change release (API v5)
- Disabled two concurrency unit tests since I believe they are flawed and do not yield reproducible results
- Added Derby database dialect. Derby 10.7.1.1 and 10.8.1.2 pass 100% of tests.
- Implemented HSQL MERGE syntax. HSQL 2.2.4 fails 1 test which is a known [bug in HSQL](https://sourceforge.net/tracker/?func=detail&aid=3390047&group_id=23316&atid=378131)