org.mule.db.commons.api.param

Class StatementDefinition<T extends StatementDefinition>

java.lang.Object

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

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

Type Parameters:

T - the generic type of the implementing type

Direct Known Subclasses:

BulkQueryDefinition, ParameterizedStatementDefinition

public abstract class StatementDefinition<T extends StatementDefinition>
extends QuerySettings

Base class containing common attributes for a statement.

Since:

1.0

Field Summary

Fields

Modifier and Type	Field and Description
protected String	sql The text of the SQL query to be executed

Constructor Summary

Constructors

Constructor and Description
StatementDefinition() Creates a new instance of StatementDefinition
StatementDefinition(String sql, List<ParameterType> parameterTypes, int queryTimeout, TimeUnit queryTimeoutUnit, Integer fetchSize, Integer maxRows) Creates a new instance of StatementDefinition with the given arguments.

Method Summary

Modifier and Type	Method and Description
protected T	copy() Returns a shallow copy of this instance.
Optional<ParameterType>	getParameterType(String paramName) Returns the type for a given parameter
List<ParameterType>	getParameterTypes()
String	getSql()
void	setSql(String sql)

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

Field Detail

sql

@Parameter
 @Text
 @DisplayName(value="SQL Query Text")
 @Placement(order=1)
 @MetadataKeyId
protected String sql

The text of the SQL query to be executed

Constructor Detail

StatementDefinition

public StatementDefinition()

Creates a new instance of StatementDefinition

StatementDefinition

public StatementDefinition(String sql,
                           List<ParameterType> parameterTypes,
                           int queryTimeout,
                           TimeUnit queryTimeoutUnit,
                           Integer fetchSize,
                           Integer maxRows)

Creates a new instance of StatementDefinition 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

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.

Method Detail

copy

protected T copy()

Returns a shallow copy of this instance.

Returns:

getParameterType

public Optional<ParameterType> getParameterType(String paramName)

Returns the type for a given parameter

Parameters:

paramName - the parameter's name

Returns:

an optional ParameterType

getParameterTypes

public List<ParameterType> getParameterTypes()

getSql

public String getSql()

setSql

public void setSql(String sql)