com.rapidminer.operator
Class SQLExecution

java.lang.Object
  com.rapidminer.operator.Operator
      com.rapidminer.operator.SQLExecution

All Implemented Interfaces:

ConfigurationListener, PreviewListener, ParameterHandler, LoggingHandler

public class SQLExecution
extends Operator

This operator performs an arbitrary SQL statement on an SQL database. The SQL query can be passed to RapidMiner via a parameter or, in case of long SQL statements, in a separate file. Please note that column names are often case sensitive. Databases may behave differently here.

Please note that this operator cannot be used to load data from databases but mereley to execute SQL statements like CREATE or ADD etc. In oder to load data from a database, the operators DatabaseExampleSource or CachedDatabaseExampleSource can be used.

Author:

Ingo Mierswa

Field Summary

static java.lang.String	PARAMETER_DATABASE_SYSTEM The parameter name for "Indicates the used database system"
static java.lang.String	PARAMETER_DATABASE_URL The parameter name for "The complete URL connection string for the database, e.g.
static java.lang.String	PARAMETER_PASSWORD The parameter name for "Password for the database.
static java.lang.String	PARAMETER_QUERY The parameter name for "SQL query.
static java.lang.String	PARAMETER_QUERY_FILE The parameter name for "File containing the query.
static java.lang.String	PARAMETER_USERNAME The parameter name for "Database username.

Constructor Summary

SQLExecution(OperatorDescription description)

Method Summary

IOObject[]	apply() Implement this method in subclasses.
protected DatabaseHandler	getConnectedDatabaseHandler()
java.lang.Class<?>[]	getInputClasses() Returns the classes that are needed as input.
java.lang.Class<?>[]	getOutputClasses() Returns the classes that are guaranteed to be returned by apply() as additional output.
java.util.List<ParameterType>	getParameterTypes() Returns a list of ParameterTypes describing the parameters of this operator.

Methods inherited from class com.rapidminer.operator.Operator

addError, addValue, addWarning, apply, checkDeprecations, checkForStop, checkIO, checkProperties, clearErrorList, cloneOperator, createExperimentTree, createExperimentTree, createFromXML, createMarkedExperimentTree, createMarkedProcessTree, createProcessTree, createProcessTree, getAddOnlyAdditionalOutput, getApplyCount, getDeliveredOutputClasses, getDeprecationInfo, getDesiredInputClasses, getEncoding, getErrorList, getExperiment, getInnerOperatorsXML, getInput, getInput, getInput, getInputDescription, getIOContainerForInApplyLoopBreakpoint, getIODescription, getLog, getName, getOperatorClassName, getOperatorDescription, getParameter, getParameterAsBoolean, getParameterAsColor, getParameterAsDouble, getParameterAsFile, getParameterAsFile, getParameterAsInputStream, getParameterAsInt, getParameterAsMatrix, getParameterAsString, getParameterList, getParameters, getParameterType, getParent, getProcess, getStartTime, getStatus, getUserDescription, getValue, getValues, getXML, hasBreakpoint, hasBreakpoint, hasInput, inApplyLoop, isDebugMode, isEnabled, isExpanded, isParallel, isParameterSet, log, logError, logNote, logWarning, performAdditionalChecks, processFinished, processStarts, register, registerOperator, remove, rename, resume, setApplyCount, setBreakpoint, setEnabled, setExpanded, setInput, setListParameter, setOperatorParameters, setParameter, setParameters, setParent, setUserDescription, toString, unregisterOperator, writeXML

Methods inherited from class java.lang.Object

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

Field Detail

PARAMETER_DATABASE_SYSTEM

public static final java.lang.String PARAMETER_DATABASE_SYSTEM

The parameter name for "Indicates the used database system"

See Also:

Constant Field Values

PARAMETER_DATABASE_URL

public static final java.lang.String PARAMETER_DATABASE_URL

The parameter name for "The complete URL connection string for the database, e.g. 'jdbc:mysql://foo.bar:portnr/database'"

See Also:

Constant Field Values

PARAMETER_USERNAME

public static final java.lang.String PARAMETER_USERNAME

The parameter name for "Database username."

See Also:

Constant Field Values

PARAMETER_PASSWORD

public static final java.lang.String PARAMETER_PASSWORD

The parameter name for "Password for the database."

See Also:

Constant Field Values

PARAMETER_QUERY

public static final java.lang.String PARAMETER_QUERY

The parameter name for "SQL query. If not set, the query is read from the file specified by 'query_file'."

See Also:

Constant Field Values

PARAMETER_QUERY_FILE

public static final java.lang.String PARAMETER_QUERY_FILE

The parameter name for "File containing the query. Only evaluated if 'query' is not set."

See Also:

Constant Field Values

Constructor Detail

SQLExecution

public SQLExecution(OperatorDescription description)

Method Detail

apply

public IOObject[] apply()
                 throws OperatorException

Description copied from class: Operator

Implement this method in subclasses.

Specified by:

apply in class Operator

Throws:

OperatorException

getConnectedDatabaseHandler

protected DatabaseHandler getConnectedDatabaseHandler()
                                               throws OperatorException,
                                                      java.sql.SQLException

Throws:

OperatorException

java.sql.SQLException

getInputClasses

public java.lang.Class<?>[] getInputClasses()

Description copied from class: Operator

Returns the classes that are needed as input. May be null or an empty (no desired input). As default, all delivered input objects are consumed and must be also delivered as output in both Operator.getOutputClasses() and Operator.apply() if this is necessary. This default behavior can be changed by overriding Operator.getInputDescription(Class). Subclasses which implement this method should not make use of parameters since this method is invoked by getParameterTypes(). Therefore, parameters are not fully available at this point of time and this might lead to exceptions. Please use InputDescriptions instead.

Specified by:

getInputClasses in class Operator

getOutputClasses

public java.lang.Class<?>[] getOutputClasses()

Description copied from class: Operator

Returns the classes that are guaranteed to be returned by apply() as additional output. Please note that input objects which should not be consumed must also be defined by this method (e.g. an example set which is changed but not consumed in the case of a preprocessing operator must be defined in both, the methods Operator.getInputClasses() and Operator.getOutputClasses()). The default behavior for input consumation is defined by Operator.getInputDescription(Class) and can be changed by overwriting this method. Objects which are not consumed (defined by changing the implementation in Operator.getInputDescription(Class)) must not be defined as additional output in this method.

May deliver null or an empy array (no additional output is produced or guaranteed). Must return the class array of delivered output objects otherwise.

Specified by:

getOutputClasses in class Operator

getParameterTypes

public java.util.List<ParameterType> getParameterTypes()

Description copied from class: Operator

Returns a list of ParameterTypes describing the parameters of this operator. The default implementation returns an empty list if no input objects can be retained and special parameters for those input objects which can be prevented from being consumed.

Specified by:

getParameterTypes in interface ParameterHandler

Overrides:

getParameterTypes in class Operator