liquibase.executor.jvm

Class JdbcExecutor

java.lang.Object

liquibase.executor.AbstractExecutor

liquibase.executor.jvm.JdbcExecutor

All Implemented Interfaces:

Executor

public class JdbcExecutor
extends AbstractExecutor
implements Executor

Class to simplify execution of SqlStatements. Based heavily on Spring's JdbcTemplate.

Note: This class is currently intended for Liquibase-internal use only and may change without notice in the future

Field Summary

Fields inherited from class liquibase.executor.AbstractExecutor

database

Constructor Summary

Constructors

Constructor and Description
JdbcExecutor()

Method Summary

Methods

Modifier and Type	Method and Description
void	comment(java.lang.String message) Adds a comment to the database.
java.lang.Object	execute(liquibase.executor.jvm.CallableStatementCallback action, java.util.List<SqlVisitor> sqlVisitors)
void	execute(SqlStatement sql) Write methods
void	execute(SqlStatement sql, java.util.List<SqlVisitor> sqlVisitors)
java.lang.Object	execute(liquibase.executor.jvm.StatementCallback action, java.util.List<SqlVisitor> sqlVisitors)
protected RowMapper	getColumnMapRowMapper() Create a new RowMapper for reading columns as key-value pairs.
protected RowMapper	getSingleColumnRowMapper(java.lang.Class requiredType) Create a new RowMapper for reading result objects from a single column.
java.lang.Object	query(SqlStatement sql, liquibase.executor.jvm.ResultSetExtractor rse)
java.lang.Object	query(SqlStatement sql, liquibase.executor.jvm.ResultSetExtractor rse, java.util.List<SqlVisitor> sqlVisitors)
java.util.List	query(SqlStatement sql, RowMapper rowMapper)
java.util.List	query(SqlStatement sql, RowMapper rowMapper, java.util.List<SqlVisitor> sqlVisitors)
int	queryForInt(SqlStatement sql)
int	queryForInt(SqlStatement sql, java.util.List<SqlVisitor> sqlVisitors)
java.util.List<java.util.Map<java.lang.String,?>>	queryForList(SqlStatement sql)
java.util.List	queryForList(SqlStatement sql, java.lang.Class elementType)
java.util.List	queryForList(SqlStatement sql, java.lang.Class elementType, java.util.List<SqlVisitor> sqlVisitors)
java.util.List<java.util.Map<java.lang.String,?>>	queryForList(SqlStatement sql, java.util.List<SqlVisitor> sqlVisitors)
long	queryForLong(SqlStatement sql)
long	queryForLong(SqlStatement sql, java.util.List<SqlVisitor> sqlVisitors)
<T> T	queryForObject(SqlStatement sql, java.lang.Class<T> requiredType) Read methods
<T> T	queryForObject(SqlStatement sql, java.lang.Class<T> requiredType, java.util.List<SqlVisitor> sqlVisitors)
java.lang.Object	queryForObject(SqlStatement sql, RowMapper rowMapper)
java.lang.Object	queryForObject(SqlStatement sql, RowMapper rowMapper, java.util.List<SqlVisitor> sqlVisitors)
int	update(SqlStatement sql)
int	update(SqlStatement sql, java.util.List<SqlVisitor> sqlVisitors)
boolean	updatesDatabase()

Methods inherited from class liquibase.executor.AbstractExecutor

applyVisitors, setDatabase

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface liquibase.executor.Executor

setDatabase

Constructor Detail

JdbcExecutor

public JdbcExecutor()

Method Detail

updatesDatabase

public boolean updatesDatabase()

Specified by:

updatesDatabase in interface Executor

execute

public java.lang.Object execute(liquibase.executor.jvm.StatementCallback action,
                       java.util.List<SqlVisitor> sqlVisitors)
                         throws DatabaseException

Throws:

DatabaseException

execute

public java.lang.Object execute(liquibase.executor.jvm.CallableStatementCallback action,
                       java.util.List<SqlVisitor> sqlVisitors)
                         throws DatabaseException

Throws:

DatabaseException

execute

public void execute(SqlStatement sql)
             throws DatabaseException

Description copied from interface: Executor

Write methods

Specified by:

execute in interface Executor

Throws:

DatabaseException

execute

public void execute(SqlStatement sql,
           java.util.List<SqlVisitor> sqlVisitors)
             throws DatabaseException

Specified by:

execute in interface Executor

Throws:

DatabaseException

query

public java.lang.Object query(SqlStatement sql,
                     liquibase.executor.jvm.ResultSetExtractor rse)
                       throws DatabaseException

Throws:

DatabaseException

query

public java.lang.Object query(SqlStatement sql,
                     liquibase.executor.jvm.ResultSetExtractor rse,
                     java.util.List<SqlVisitor> sqlVisitors)
                       throws DatabaseException

Throws:

DatabaseException

query

public java.util.List query(SqlStatement sql,
                   RowMapper rowMapper)
                     throws DatabaseException

Throws:

DatabaseException

query

public java.util.List query(SqlStatement sql,
                   RowMapper rowMapper,
                   java.util.List<SqlVisitor> sqlVisitors)
                     throws DatabaseException

Throws:

DatabaseException

queryForObject

public java.lang.Object queryForObject(SqlStatement sql,
                              RowMapper rowMapper)
                                throws DatabaseException

Throws:

DatabaseException

queryForObject

public java.lang.Object queryForObject(SqlStatement sql,
                              RowMapper rowMapper,
                              java.util.List<SqlVisitor> sqlVisitors)
                                throws DatabaseException

Throws:

DatabaseException

queryForObject

public <T> T queryForObject(SqlStatement sql,
                   java.lang.Class<T> requiredType)
                 throws DatabaseException

Description copied from interface: Executor

Read methods

Specified by:

queryForObject in interface Executor

Throws:

DatabaseException

queryForObject

public <T> T queryForObject(SqlStatement sql,
                   java.lang.Class<T> requiredType,
                   java.util.List<SqlVisitor> sqlVisitors)
                 throws DatabaseException

Specified by:

queryForObject in interface Executor

Throws:

DatabaseException

queryForLong

public long queryForLong(SqlStatement sql)
                  throws DatabaseException

Specified by:

queryForLong in interface Executor

Throws:

DatabaseException

queryForLong

public long queryForLong(SqlStatement sql,
                java.util.List<SqlVisitor> sqlVisitors)
                  throws DatabaseException

Specified by:

queryForLong in interface Executor

Throws:

DatabaseException

queryForInt

public int queryForInt(SqlStatement sql)
                throws DatabaseException

Specified by:

queryForInt in interface Executor

Throws:

DatabaseException

queryForInt

public int queryForInt(SqlStatement sql,
              java.util.List<SqlVisitor> sqlVisitors)
                throws DatabaseException

Specified by:

queryForInt in interface Executor

Throws:

DatabaseException

queryForList

public java.util.List queryForList(SqlStatement sql,
                          java.lang.Class elementType)
                            throws DatabaseException

Specified by:

queryForList in interface Executor

Throws:

DatabaseException

queryForList

public java.util.List queryForList(SqlStatement sql,
                          java.lang.Class elementType,
                          java.util.List<SqlVisitor> sqlVisitors)
                            throws DatabaseException

Specified by:

queryForList in interface Executor

Throws:

DatabaseException

queryForList

public java.util.List<java.util.Map<java.lang.String,?>> queryForList(SqlStatement sql)
                                                               throws DatabaseException

Specified by:

queryForList in interface Executor

Throws:

DatabaseException

queryForList

public java.util.List<java.util.Map<java.lang.String,?>> queryForList(SqlStatement sql,
                                                             java.util.List<SqlVisitor> sqlVisitors)
                                                               throws DatabaseException

Specified by:

queryForList in interface Executor

Throws:

DatabaseException

update

public int update(SqlStatement sql)
           throws DatabaseException

Specified by:

update in interface Executor

Throws:

DatabaseException

update

public int update(SqlStatement sql,
         java.util.List<SqlVisitor> sqlVisitors)
           throws DatabaseException

Specified by:

update in interface Executor

Throws:

DatabaseException

getColumnMapRowMapper

protected RowMapper getColumnMapRowMapper()

Create a new RowMapper for reading columns as key-value pairs.

Returns:

the RowMapper to use

See Also:

ColumnMapRowMapper

getSingleColumnRowMapper

protected RowMapper getSingleColumnRowMapper(java.lang.Class requiredType)

Create a new RowMapper for reading result objects from a single column.

Parameters:

requiredType - the type that each result object is expected to match

Returns:

the RowMapper to use

See Also:

SingleColumnRowMapper

comment

public void comment(java.lang.String message)
             throws DatabaseException

Description copied from interface: Executor

Adds a comment to the database. Currently does nothing but is over-ridden in the output JDBC template

Specified by:

comment in interface Executor

Throws:

DatabaseException