BATCH-760: added remaining database specific implementations and a delegating implementation that uses database metadata to determine which implementation to delegate to

This commit is contained in:
trisberg
2008-08-26 05:16:58 +00:00
parent 9798bfefe1
commit 4e39831c82
13 changed files with 658 additions and 0 deletions

View File

@@ -123,6 +123,7 @@ public class JdbcPagingItemReader<T> extends AbstractItemReaderItemStream<T> imp
jdbcTemplate.setMaxRows(pageSize);
this.simpleJdbcTemplate = new SimpleJdbcTemplate(jdbcTemplate);
Assert.notNull(queryProvider);
queryProvider.init(dataSource);
this.firstPageSql = queryProvider.generateFirstPageQuery(pageSize);
this.remainingPagesSql = queryProvider.generateRemainingPagesQuery(pageSize);
}

View File

@@ -0,0 +1,35 @@
package org.springframework.batch.item.database.support;
/**
* Oracle implementation of a {@link PagingQueryProvider} using
* database specific features.
*
* @author Thomas Risberg
* @since 2.0
*/
public class Db2PagingQueryProvider extends SqlWindowingPagingQueryProvider {
@Override
public String generateFirstPageQuery(int pageSize) {
StringBuilder sql = new StringBuilder();
sql.append("SELECT ").append(getSelectClause());
sql.append(" FROM ").append(getFromClause());
sql.append(getWhereClause() == null ? "" : " WHERE " + getWhereClause());
sql.append(" FETCH FIRST ").append(pageSize).append(" ROWS ONLY");
return sql.toString();
}
@Override
public String generateRemainingPagesQuery(int pageSize) {
StringBuilder sql = new StringBuilder();
sql.append("SELECT ").append(getSelectClause());
sql.append(" FROM ").append(getFromClause());
sql.append(" WHERE ").append(getSortKey()).append(" > ?");
sql.append(getWhereClause() == null ? "" : " AND " + getWhereClause());
sql.append(" FETCH FIRST ").append(pageSize).append(" ROWS ONLY");
return sql.toString();
}
}

View File

@@ -0,0 +1,39 @@
package org.springframework.batch.item.database.support;
import org.springframework.jdbc.support.JdbcUtils;
import org.springframework.dao.InvalidDataAccessResourceUsageException;
import javax.sql.DataSource;
/**
* Oracle implementation of a {@link org.springframework.batch.item.database.support.PagingQueryProvider} using
* database specific features.
*
* @author Thomas Risberg
* @since 2.0
*/
public class OraclePagingQueryProvider extends SqlWindowingPagingQueryProvider {
@Override
public String generateFirstPageQuery(int pageSize) {
StringBuilder sql = new StringBuilder();
sql.append("SELECT ").append(getSelectClause());
sql.append(" FROM ").append(getFromClause());
sql.append(" WHERE ROWNUM <= ").append(pageSize);
sql.append(getWhereClause() == null ? "" : " AND " + getWhereClause());
return sql.toString();
}
@Override
public String generateRemainingPagesQuery(int pageSize) {
StringBuilder sql = new StringBuilder();
sql.append("SELECT ").append(getSelectClause());
sql.append(" FROM ").append(getFromClause());
sql.append(" WHERE ").append(getSortKey()).append(" > ?");
sql.append(" AND ROWNUM <= ").append(pageSize);
sql.append(getWhereClause() == null ? "" : " AND " + getWhereClause());
return sql.toString();
}
}

View File

@@ -0,0 +1,47 @@
package org.springframework.batch.item.database.support;
/**
* MySQL implementation of a {@link org.springframework.batch.item.database.support.PagingQueryProvider} using database specific features.
*
* @author Thomas Risberg
* @since 2.0
*/
public class PostgresPagingQueryProvider extends AbstractSqlPagingQueryProvider {
@Override
public String generateFirstPageQuery(int pageSize) {
StringBuilder sql = new StringBuilder();
sql.append("SELECT ").append(getSelectClause());
sql.append(" FROM ").append(getFromClause());
sql.append(getWhereClause() == null ? "" : " WHERE " + getWhereClause());
sql.append(" LIMIT ").append(pageSize);
return sql.toString();
}
@Override
public String generateRemainingPagesQuery(int pageSize) {
StringBuilder sql = new StringBuilder();
sql.append("SELECT ").append(getSelectClause());
sql.append(" FROM ").append(getFromClause());
sql.append(" WHERE ").append(getSortKey()).append(" > ?");
sql.append(getWhereClause() == null ? "" : " AND " + getWhereClause());
sql.append(" LIMIT ").append(pageSize);
return sql.toString();
}
@Override
public String generateJumpToItemQuery(int itemIndex, int pageSize) {
int page = itemIndex / pageSize;
int offset = (page * pageSize) - 1;
StringBuilder sql = new StringBuilder();
sql.append("SELECT ").append(getSortKey()).append(" AS SORT_KEY");
sql.append(" FROM ").append(getFromClause()).append(getWhereClause() == null ? "" : " WHERE " + getWhereClause());
sql.append(" LIMIT ").append(offset).append(" 1");
return sql.toString();
}
}

View File

@@ -0,0 +1,91 @@
package org.springframework.batch.item.database.support;
import org.springframework.jdbc.support.JdbcUtils;
import org.springframework.dao.InvalidDataAccessResourceUsageException;
import javax.sql.DataSource;
import java.util.List;
import java.util.Arrays;
/**
* Generic Paging Query Provider using standard SQL:2003 windowing functions. These features are supported by
* DB2, Oracle, SQL Server 2005, Sybase and Apache Derby version 10.4.1.3
*
* @author Thomas Risberg
* @since 2.0
*/
public class SimpleDelegatingPagingQueryProvider extends AbstractSqlPagingQueryProvider {
/* List of supported database products */
public static final List<String> supportedDatabaseProducts = Arrays.asList(
"Apache Derby",
"DB2",
"HSQL Database Engine",
"Microsoft SQL Server",
"MySQL",
"Oracle",
"PostgreSQL",
"Sybase"
);
AbstractSqlPagingQueryProvider delegate;
@Override
public void init(DataSource dataSource) throws Exception {
super.init(dataSource);
String databaseProductName = JdbcUtils.commonDatabaseName(
JdbcUtils.extractDatabaseMetaData(dataSource, "getDatabaseProductName").toString());
if ("Apache Derby".equals(databaseProductName)) {
delegate = new DerbyPagingQueryProvider();
}
else if ("DB2".equals(databaseProductName)) {
delegate = new Db2PagingQueryProvider();
}
else if ("HSQL Database Engine".equals(databaseProductName)) {
delegate = new HsqlPagingQueryProvider();
}
else if ("Microsoft SQL Server".equals(databaseProductName)) {
delegate = new SqlServerPagingQueryProvider();
}
else if ("MySQL".equals(databaseProductName)) {
delegate = new MySqlPagingQueryProvider();
}
else if ("Oracle".equals(databaseProductName)) {
delegate = new OraclePagingQueryProvider();
}
else if ("PostgreSQL".equals(databaseProductName)) {
delegate = new PostgresPagingQueryProvider();
}
else if ("Sybase".equals(databaseProductName)) {
delegate = new SybasePagingQueryProvider();
}
else {
throw new InvalidDataAccessResourceUsageException(databaseProductName +
" is not a supported database. The supported databases are " +
supportedDatabaseProducts.toString());
}
delegate.setSelectClause(this.getSelectClause());
delegate.setFromClause(this.getFromClause());
if (this.getWhereClause() != null) {
delegate.setWhereClause(this.getWhereClause());
}
delegate.setSortKey(this.getSortKey());
delegate.init(dataSource);
}
@Override
public String generateFirstPageQuery(int pageSize) {
return delegate.generateFirstPageQuery(pageSize);
}
@Override
public String generateRemainingPagesQuery(int pageSize) {
return delegate.generateRemainingPagesQuery(pageSize);
}
@Override
public String generateJumpToItemQuery(int itemIndex, int pageSize) {
return delegate.generateJumpToItemQuery(itemIndex, pageSize);
}
}

View File

@@ -0,0 +1,32 @@
package org.springframework.batch.item.database.support;
/**
* Oracle implementation of a {@link org.springframework.batch.item.database.support.PagingQueryProvider} using
* database specific features.
*
* @author Thomas Risberg
* @since 2.0
*/
public class SqlServerPagingQueryProvider extends SqlWindowingPagingQueryProvider {
@Override
public String generateFirstPageQuery(int pageSize) {
StringBuilder sql = new StringBuilder();
sql.append("SELECT ").append("TOP ").append(pageSize).append(" ").append(getSelectClause());
sql.append(" FROM ").append(getFromClause());
sql.append(getWhereClause() == null ? "" : " WHERE " + getWhereClause());
return sql.toString();
}
@Override
public String generateRemainingPagesQuery(int pageSize) {
StringBuilder sql = new StringBuilder();
sql.append("SELECT ").append("TOP ").append(pageSize).append(" ").append(getSelectClause());
sql.append(" FROM ").append(getFromClause());
sql.append(" WHERE ").append(getSortKey()).append(" > ?");
sql.append(getWhereClause() == null ? "" : " AND " + getWhereClause());
return sql.toString();
}
}

View File

@@ -24,6 +24,7 @@ package org.springframework.batch.item.database.support;
*/
public class SqlWindowingPagingQueryProvider extends AbstractSqlPagingQueryProvider {
@Override
public String generateFirstPageQuery(int pageSize) {
StringBuilder sql = new StringBuilder();
sql.append("SELECT * FROM ( ");
@@ -35,6 +36,7 @@ public class SqlWindowingPagingQueryProvider extends AbstractSqlPagingQueryProvi
return sql.toString();
}
@Override
public String generateRemainingPagesQuery(int pageSize) {
StringBuilder sql = new StringBuilder();
sql.append("SELECT * FROM ( ");
@@ -47,6 +49,7 @@ public class SqlWindowingPagingQueryProvider extends AbstractSqlPagingQueryProvi
return sql.toString();
}
@Override
public String generateJumpToItemQuery(int itemIndex, int pageSize) {
int page = itemIndex / pageSize;
int lastRowNum = (page * pageSize);

View File

@@ -0,0 +1,32 @@
package org.springframework.batch.item.database.support;
/**
* Oracle implementation of a {@link PagingQueryProvider} using
* database specific features.
*
* @author Thomas Risberg
* @since 2.0
*/
public class SybasePagingQueryProvider extends SqlWindowingPagingQueryProvider {
@Override
public String generateFirstPageQuery(int pageSize) {
StringBuilder sql = new StringBuilder();
sql.append("SELECT ").append("TOP ").append(pageSize).append(" ").append(getSelectClause());
sql.append(" FROM ").append(getFromClause());
sql.append(getWhereClause() == null ? "" : " WHERE " + getWhereClause());
return sql.toString();
}
@Override
public String generateRemainingPagesQuery(int pageSize) {
StringBuilder sql = new StringBuilder();
sql.append("SELECT ").append("TOP ").append(pageSize).append(" ").append(getSelectClause());
sql.append(" FROM ").append(getFromClause());
sql.append(" WHERE ").append(getSortKey()).append(" > ?");
sql.append(getWhereClause() == null ? "" : " AND " + getWhereClause());
return sql.toString();
}
}