org.mule.db.commons.api.param

Class StoredProcedureCall

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<StoredProcedureCall>

org.mule.db.commons.api.param.StoredProcedureCall

public class StoredProcedureCall
extends ParameterizedStatementDefinition<StoredProcedureCall>

The definition of the invocation to a stored procedure

Since:

1.0

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Object>	inOutParameters A Map which keys are the name of a parameter to be set on the JDBC prepared statement which is both input and output.

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
StoredProcedureCall() Creates a new instance of StoredProcedureCall.
StoredProcedureCall(String sql, List<ParameterType> parameterTypes, Map<String,Object> inputParameters, Map<String,Object> inOutParameters, List<OutputParameter> outputParameters, int queryTimeout, TimeUnit queryTimeoutUnit, Integer fetchSize, Integer maxRows) Creates a new instance of StoredProcedureCalll with the given arguments.

Method Summary

Modifier and Type	Method and Description
protected StoredProcedureCall	copy() Returns a shallow copy of this instance.
Optional<org.mule.runtime.api.util.Reference<Object>>	getInOutParameter(String name)
Map<String,Object>	getInOutParameters()
Optional<OutputParameter>	getOutputParameter(String name)
List<ParameterType>	getOutputParameters()

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

addInputParameter, 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

Field Detail

inOutParameters

@Parameter
 @Optional
 @NullSafe
 @DisplayName(value="Input - Output Parameters")
 @ParameterDsl(allowReferences=false)
protected Map<String,Object> inOutParameters

A Map which keys are the name of a parameter to be set on the JDBC prepared statement which is both input and output.

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.

Constructor Detail

StoredProcedureCall

public StoredProcedureCall()

Creates a new instance of StoredProcedureCall.

StoredProcedureCall

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

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

inOutParameters - * LinkedHashMapMap which keys are the name of a parameter to be set on the JDBC prepared statement which is both input and output.

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.

outputParameters - A list of output parameters to be set on the JDBC prepared statement. Each parameter should be referenced in the sql text using a semicolon prefix (E.g: call multiply(:value, :result))

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. This property is required when streaming is true;

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

Method Detail

copy

protected StoredProcedureCall copy()

Description copied from class: StatementDefinition

Returns a shallow copy of this instance.

Overrides:

copy in class ParameterizedStatementDefinition<StoredProcedureCall>

Returns:

getOutputParameter

public Optional<OutputParameter> getOutputParameter(String name)

getInOutParameter

public Optional<org.mule.runtime.api.util.Reference<Object>> getInOutParameter(String name)

getOutputParameters

public List<ParameterType> getOutputParameters()

getInOutParameters

public Map<String,Object> getInOutParameters()