org.mule.extension.db.internal.operation

Class DmlOperations

java.lang.Object

org.mule.extension.db.internal.operation.DmlOperations

public class DmlOperations
extends Object

Contains a set of operations for performing single statement DML operations

Since:

4.0

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	DEFAULT_FETCH_SIZE
protected static String	QUERY_GROUP
protected static String	QUERY_SETTINGS
protected QueryResolver<ParameterizedStatementDefinition>	queryResolver

Constructor Summary

Constructors

Constructor and Description
DmlOperations()

Method Summary

Modifier and Type	Method and Description
int	delete(QueryDefinition query, DbConnector connector, DbConnection connection) Deletes data in a database.
protected StatementResult	executeUpdate(QueryDefinition query, AutoGenerateKeysAttributes autoGenerateKeysAttributes, DbConnection connection, Query resolvedQuery)
protected AutoGenerateKeysStrategy	getAutoGeneratedKeysStrategy(AutoGenerateKeysAttributes keyAttributes)
protected QueryStatementFactory	getStatementFactory(boolean streaming, QuerySettings settings)
StatementResult	insert(QueryDefinition query, AutoGenerateKeysAttributes autoGenerateKeysAttributes, DbConnector connector, DbConnection connection) Inserts data into a Database
protected Query	resolveQuery(QueryDefinition query, DbConnector connector, DbConnection connection, QueryType... validTypes)
protected Query	resolveQuery(StoredProcedureCall call, DbConnector connector, DbConnection connection, QueryType... validTypes)
org.mule.runtime.extension.api.runtime.operation.InterceptingCallback<Object>	select(QueryDefinition query, boolean streaming, DbConnector connector, DbConnection connection) Selects data from a database
org.mule.runtime.extension.api.runtime.operation.InterceptingCallback<Map<String,Object>>	storedProcedure(StoredProcedureCall call, boolean streaming, AutoGenerateKeysAttributes autoGenerateKeysAttributes, DbConnector connector, DbConnection connection) Invokes a Stored Procedure on the database.
StatementResult	update(QueryDefinition query, AutoGenerateKeysAttributes autoGenerateKeysAttributes, DbConnector connector, DbConnection connection) Updates data in a database.
protected void	validateNoParameterTypeIsUnused(Query query, List<ParameterType> parameterTypes)
protected void	validateQueryType(QueryTemplate queryTemplate, List<QueryType> validTypes)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_FETCH_SIZE

protected static final int DEFAULT_FETCH_SIZE

See Also:

Constant Field Values

QUERY_GROUP

protected static final String QUERY_GROUP

See Also:

Constant Field Values

QUERY_SETTINGS

protected static final String QUERY_SETTINGS

See Also:

Constant Field Values

queryResolver

protected final QueryResolver<ParameterizedStatementDefinition> queryResolver

Constructor Detail

DmlOperations

public DmlOperations()

Method Detail

select

@OutputResolver(output=SelectMetadataResolver.class)
public org.mule.runtime.extension.api.runtime.operation.InterceptingCallback<Object> select(@ParameterGroup(name="Query") @Placement(tab="Advanced")
                                                                                                                                                 QueryDefinition query,
                                                                                                                                                 @Optional(defaultValue="false") @Expression(value=NOT_SUPPORTED) @Placement(tab="Advanced") @DisplayName(value="Stream Response")
                                                                                                                                                 boolean streaming,
                                                                                                                                                 @UseConfig
                                                                                                                                                 DbConnector connector,
                                                                                                                                                 @Connection
                                                                                                                                                 DbConnection connection)
                                                                                                                                          throws SQLException

Selects data from a database

Parameters:

query - a QueryDefinition as a parameter group

streaming - if enabled retrieves the result set in blocks so that memory is not exhausted in case of large data sets. This works in tandem with the fetch size parameter

connector - the acting connector

connection - the acting connection

Returns:

depending on the value of streaming, it can be a List or Iterator of maps

Throws:

SQLException - if an error is produced

insert

public StatementResult insert(@ParameterGroup(name="Query") @Placement(tab="Advanced")
                              QueryDefinition query,
                              @ParameterGroup(name="Auto Generate Keys")
                              AutoGenerateKeysAttributes autoGenerateKeysAttributes,
                              @UseConfig
                              DbConnector connector,
                              @Connection
                              DbConnection connection)
                       throws SQLException

Inserts data into a Database

Parameters:

query - QueryDefinition as a parameter group

autoGenerateKeysAttributes - an AutoGenerateKeysAttributes as a parameter group

connector - the acting connector

connection - the acting connection

Returns:

a StatementResult

Throws:

SQLException - if an error is produced

update

public StatementResult update(@ParameterGroup(name="Query")
                              QueryDefinition query,
                              @ParameterGroup(name="Auto Generate Keys")
                              AutoGenerateKeysAttributes autoGenerateKeysAttributes,
                              @UseConfig
                              DbConnector connector,
                              @Connection
                              DbConnection connection)
                       throws SQLException

Updates data in a database.

Parameters:

query - QueryDefinition as a parameter group

autoGenerateKeysAttributes - an AutoGenerateKeysAttributes as a parameter group

connector - the acting connector

connection - the acting connection

Returns:

a StatementResult

Throws:

SQLException - if an error is produced

delete

public int delete(@ParameterGroup(name="Query")
                  QueryDefinition query,
                  @UseConfig
                  DbConnector connector,
                  @Connection
                  DbConnection connection)
           throws SQLException

Deletes data in a database.

Parameters:

query - QueryDefinition as a parameter group

connector - the acting connector

connection - the acting connection

Returns:

the number of affected rows

Throws:

SQLException - if an error is produced

storedProcedure

@OutputResolver(output=StoredProcedureMetadataResolver.class)
public org.mule.runtime.extension.api.runtime.operation.InterceptingCallback<Map<String,Object>> storedProcedure(@ParameterGroup(name="Query")
                                                                                                                                                                               StoredProcedureCall call,
                                                                                                                                                                               @Optional(defaultValue="false") @Expression(value=NOT_SUPPORTED)
                                                                                                                                                                               boolean streaming,
                                                                                                                                                                               @ParameterGroup(name="Auto Generate Keys")
                                                                                                                                                                               AutoGenerateKeysAttributes autoGenerateKeysAttributes,
                                                                                                                                                                               @UseConfig
                                                                                                                                                                               DbConnector connector,
                                                                                                                                                                               @Connection
                                                                                                                                                                               DbConnection connection)
                                                                                                                                                                        throws SQLException

Invokes a Stored Procedure on the database.

Parameters:

call - a StoredProcedureCall as a parameter group

streaming - if enabled retrieves the result set in blocks so that memory is not exhausted in case of large data sets. This works in tandem with the fetch size parameter

autoGenerateKeysAttributes - an AutoGenerateKeysAttributes as a parameter group

connector - the acting connector

connection - the acting connection

Returns:

A Map with the procedure's output

Throws:

SQLException - if an error is produced

resolveQuery

protected Query resolveQuery(StoredProcedureCall call,
                             DbConnector connector,
                             DbConnection connection,
                             QueryType... validTypes)

getStatementFactory

protected QueryStatementFactory getStatementFactory(boolean streaming,
                                                    QuerySettings settings)

executeUpdate

protected StatementResult executeUpdate(QueryDefinition query,
                                        AutoGenerateKeysAttributes autoGenerateKeysAttributes,
                                        DbConnection connection,
                                        Query resolvedQuery)
                                 throws SQLException

Throws:

SQLException

resolveQuery

protected Query resolveQuery(QueryDefinition query,
                             DbConnector connector,
                             DbConnection connection,
                             QueryType... validTypes)

validateQueryType

protected void validateQueryType(QueryTemplate queryTemplate,
                                 List<QueryType> validTypes)

validateNoParameterTypeIsUnused

protected void validateNoParameterTypeIsUnused(Query query,
                                               List<ParameterType> parameterTypes)

getAutoGeneratedKeysStrategy

protected AutoGenerateKeysStrategy getAutoGeneratedKeysStrategy(AutoGenerateKeysAttributes keyAttributes)