org.mule.db.commons.api.param

Class QueryDefinition

java.lang.Object

org.mule.db.commons.api.param.QuerySettings

org.mule.db.commons.api.param.StatementDefinition<T>

org.mule.db.commons.api.param.ParameterizedStatementDefinition<QueryDefinition>

org.mule.db.commons.api.param.QueryDefinition

public class QueryDefinition
extends ParameterizedStatementDefinition<QueryDefinition>

The definition for a DML query

Since:

1.0

Field Summary

Fields inherited from class org.mule.db.commons.api.param.ParameterizedStatementDefinition

inputParameters

Fields inherited from class org.mule.db.commons.api.param.StatementDefinition

sql

Constructor Summary

Constructors

Constructor and Description
QueryDefinition() Creates a new Instance of QueryDefinition.
QueryDefinition(String sql, List<ParameterType> parameterTypes, Map<String,Object> inputParameters, int queryTimeout, TimeUnit queryTimeoutUnit, Integer fetchSize, Integer maxRows) Creates a mew Instance of QueryDefinition with the given arguments.

Method Summary

Methods inherited from class org.mule.db.commons.api.param.ParameterizedStatementDefinition

addInputParameter, copy, findParameter, getInputParameter, getInputParameters

Methods inherited from class org.mule.db.commons.api.param.StatementDefinition

getParameterType, getParameterTypes, getSql, setSql

Methods inherited from class org.mule.db.commons.api.param.QuerySettings

copyInto, getFetchSize, getMaxRows, getQueryTimeout, getQueryTimeoutUnit

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryDefinition

public QueryDefinition()

Creates a new Instance of QueryDefinition.

QueryDefinition

public QueryDefinition(String sql,
                       List<ParameterType> parameterTypes,
                       Map<String,Object> inputParameters,
                       int queryTimeout,
                       TimeUnit queryTimeoutUnit,
                       Integer fetchSize,
                       Integer maxRows)

Creates a mew Instance of QueryDefinition with the given arguments.

Parameters:

sql - The text of the SQL query to be executed

parameterTypes - Allows to optionally specify the type of one or more of the parameters in the query. If provided, you're not even required to reference all of the parameters, but you cannot reference a parameter not present in the input values

inputParameters - A Map which keys are the name of an input parameter to be set on the JDBC prepared statement. Each parameter should be referenced in the sql text using a semicolon prefix (E.g: where id = :myParamName)).

The map's values will contain the actual assignation for each parameter.

queryTimeout - Indicates the minimum amount of time before the JDBC driver attempts to cancel a running statement. No timeout is used by default.

queryTimeoutUnit - A TimeUnit which qualifies the QuerySettings.queryTimeout

fetchSize - Indicates how many rows to fetch from the database when rows are read from a resultSet.

maxRows - * Sets the limit for the maximum number of rows that any ResultSet object generated by this message processor can contain for the given number. If the limit is exceeded, the excess rows are silently dropped.