Class DynamicSQLRowMeta
java.lang.Object
org.pentaho.di.trans.step.BaseStepMeta
org.pentaho.di.trans.step.BaseDatabaseStepMeta
org.pentaho.di.trans.steps.dynamicsqlrow.DynamicSQLRowMeta
- All Implemented Interfaces:
Cloneable
,StepAttributesInterface
,StepMetaInterface
-
Field Summary
Fields inherited from class org.pentaho.di.trans.step.BaseStepMeta
attributes, databases, log, loggingObject, parentStepMeta, repository, STEP_ATTRIBUTES_FILE
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
analyseImpact
(List<DatabaseImpact> impact, TransMeta transMeta, StepMeta stepMeta, org.pentaho.di.core.row.RowMetaInterface prev, String[] input, String[] output, org.pentaho.di.core.row.RowMetaInterface info, Repository repository, org.pentaho.metastore.api.IMetaStore metaStore) Each step must be able to report on the impact it has on a database, table field, etc.void
check
(List<org.pentaho.di.core.CheckResultInterface> remarks, TransMeta transMeta, StepMeta stepMeta, org.pentaho.di.core.row.RowMetaInterface prev, String[] input, String[] output, org.pentaho.di.core.row.RowMetaInterface info, org.pentaho.di.core.variables.VariableSpace space, Repository repository, org.pentaho.metastore.api.IMetaStore metaStore) Checks the settings of this step and puts the findings in a remarks List.clone()
Make an exact copy of this step, make sure to explicitly copy Collections etc.org.pentaho.di.core.database.DatabaseMeta
void
getFields
(org.pentaho.di.core.row.RowMetaInterface row, String name, org.pentaho.di.core.row.RowMetaInterface[] info, StepMeta nextStep, org.pentaho.di.core.variables.VariableSpace space, Repository repository, org.pentaho.metastore.api.IMetaStore metaStore) Gets the fields.int
getSql()
getStep
(StepMeta stepMeta, StepDataInterface stepDataInterface, int cnr, TransMeta tr, Trans trans) Get the executing step, needed by Trans to launch a step.Get a new instance of the appropriate data class.org.pentaho.di.core.database.DatabaseMeta[]
This method returns all the database connections that are used by the step.getXML()
Produces the XML string that describes this step's information.boolean
boolean
boolean
void
loadXML
(Node stepnode, List<org.pentaho.di.core.database.DatabaseMeta> databases, org.pentaho.metastore.api.IMetaStore metaStore) Load the values for this step from an XML Nodevoid
readRep
(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, org.pentaho.di.repository.ObjectId id_step, List<org.pentaho.di.core.database.DatabaseMeta> databases) Read the steps information from a Kettle repositoryvoid
saveRep
(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, org.pentaho.di.repository.ObjectId id_transformation, org.pentaho.di.repository.ObjectId id_step) Save the steps data into a Kettle repositoryvoid
setDatabaseMeta
(org.pentaho.di.core.database.DatabaseMeta database) void
Set default valuesvoid
setOuterJoin
(boolean outerJoin) void
setQueryOnlyOnChange
(boolean queryonlyonchange) void
setRowLimit
(int rowLimit) void
void
setSQLFieldName
(String sqlfieldname) void
setVariableReplace
(boolean replacevars) boolean
Methods inherited from class org.pentaho.di.trans.step.BaseStepMeta
analyseImpact, cancelQueries, check, check, createEntry, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, exportResources, exportResources, extractStepMetadataEntries, findAttribute, findParent, findParentEntry, getActiveReferencedObjectDescription, getDescription, getDialogClassName, getFields, getLog, getLogChannelId, getName, getObjectCopy, getObjectId, getObjectRevision, getObjectType, getOptionalStreams, getParent, getParentStepMeta, getReferencedObjectDescriptions, getRepCode, getRepositoryDirectory, getRequiredFields, getRequiredFields, getResourceDependencies, getSQLStatements, getSQLStatements, getStepInjectionMetadataEntries, getStepIOMeta, getStepIOMeta, getStepMetaInjectionInterface, getSupportedTransformationTypes, getTableFields, getTooltip, getUsedArguments, getUsedLibraries, getXmlCode, handleStreamSelection, hasChanged, hasRepositoryReferences, isBasic, isDebug, isDetailed, isReferencedObjectEnabled, isRowLevel, loadReferencedObject, loadReferencedObject, loadStepAttributes, loadXML, loadXML, logBasic, logBasic, logDebug, logDebug, logDetailed, logDetailed, logError, logError, logError, logMinimal, logMinimal, logRowlevel, logRowlevel, lookupRepositoryReferences, readRep, readRep, resetStepIoMeta, saveRep, searchInfoAndTargetSteps, setChanged, setChanged, setParentStepMeta, setStepIOMeta
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.pentaho.di.trans.step.StepMetaInterface
analyseImpact, cancelQueries, check, cleanAfterHopFromRemove, cleanAfterHopFromRemove, cleanAfterHopToRemove, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, exportResources, exportResources, extractStepMetadataEntries, fetchTransMeta, getActiveReferencedObjectDescription, getDialogClassName, getFields, getOptionalStreams, getParentStepMeta, getReferencedObjectDescriptions, getRequiredFields, getResourceDependencies, getSQLStatements, getSQLStatements, getStepIOMeta, getStepMetaInjectionInterface, getSupportedTransformationTypes, getTableFields, getUsedArguments, getUsedLibraries, handleStreamSelection, hasChanged, hasRepositoryReferences, isReferencedObjectEnabled, loadReferencedObject, loadXML, lookupRepositoryReferences, passDataToServletOutput, readRep, resetStepIoMeta, saveRep, searchInfoAndTargetSteps, setChanged, setParentStepMeta
-
Field Details
-
queryonlyonchange
public boolean queryonlyonchange
-
-
Constructor Details
-
DynamicSQLRowMeta
public DynamicSQLRowMeta()
-
-
Method Details
-
getDatabaseMeta
public org.pentaho.di.core.database.DatabaseMeta getDatabaseMeta()- Specified by:
getDatabaseMeta
in classBaseDatabaseStepMeta
- Returns:
- Returns the database.
-
setDatabaseMeta
public void setDatabaseMeta(org.pentaho.di.core.database.DatabaseMeta database) - Parameters:
database
- The database to set.
-
isOuterJoin
public boolean isOuterJoin()- Returns:
- Returns the outerJoin.
-
setOuterJoin
public void setOuterJoin(boolean outerJoin) - Parameters:
outerJoin
- The outerJoin to set.
-
isVariableReplace
public boolean isVariableReplace()- Returns:
- Returns the replacevars.
-
setVariableReplace
public void setVariableReplace(boolean replacevars) - Parameters:
replacevars
- The replacevars to set.
-
isQueryOnlyOnChange
public boolean isQueryOnlyOnChange()- Returns:
- Returns the queryonlyonchange.
-
setQueryOnlyOnChange
public void setQueryOnlyOnChange(boolean queryonlyonchange) - Parameters:
queryonlyonchange
- The queryonlyonchange to set.
-
getRowLimit
public int getRowLimit()- Returns:
- Returns the rowLimit.
-
setRowLimit
public void setRowLimit(int rowLimit) - Parameters:
rowLimit
- The rowLimit to set.
-
getSql
- Returns:
- Returns the sql.
-
setSql
- Parameters:
sql
- The sql to set.
-
getSQLFieldName
- Returns:
- Returns the sqlfieldname.
-
setSQLFieldName
- Parameters:
sql
- The sqlfieldname to set.
-
loadXML
public void loadXML(Node stepnode, List<org.pentaho.di.core.database.DatabaseMeta> databases, org.pentaho.metastore.api.IMetaStore metaStore) throws org.pentaho.di.core.exception.KettleXMLException Description copied from interface:StepMetaInterface
Load the values for this step from an XML Node- Specified by:
loadXML
in interfaceStepMetaInterface
- Overrides:
loadXML
in classBaseStepMeta
- Parameters:
stepnode
- the Node to get the info fromdatabases
- The available list of databases to reference tometaStore
- the metastore to optionally load external reference metadata from- Throws:
org.pentaho.di.core.exception.KettleXMLException
- When an unexpected XML error occurred. (malformed etc.)
-
clone
Description copied from interface:StepMetaInterface
Make an exact copy of this step, make sure to explicitly copy Collections etc.- Specified by:
clone
in interfaceStepMetaInterface
- Overrides:
clone
in classBaseStepMeta
- Returns:
- an exact copy of this step
-
setDefault
public void setDefault()Description copied from interface:StepMetaInterface
Set default values- Specified by:
setDefault
in interfaceStepMetaInterface
-
getFields
public void getFields(org.pentaho.di.core.row.RowMetaInterface row, String name, org.pentaho.di.core.row.RowMetaInterface[] info, StepMeta nextStep, org.pentaho.di.core.variables.VariableSpace space, Repository repository, org.pentaho.metastore.api.IMetaStore metaStore) throws org.pentaho.di.core.exception.KettleStepException Description copied from class:BaseStepMeta
Gets the fields.- Specified by:
getFields
in interfaceStepMetaInterface
- Overrides:
getFields
in classBaseStepMeta
- Parameters:
row
- the input row meta that is modified in this method to reflect the output row metadata of the stepname
- Name of the step to use as input for the origin field in the valuesinfo
- Fields used as extra lookup informationnextStep
- the next step that is targetedspace
- the space The variable space to use to replace variablesrepository
- the repository to use to load Kettle metadata objects impacting the output fieldsmetaStore
- the MetaStore to use to load additional external data or metadata impacting the output fields- Throws:
org.pentaho.di.core.exception.KettleStepException
- the kettle step exception
-
getXML
Description copied from class:BaseStepMeta
Produces the XML string that describes this step's information.- Specified by:
getXML
in interfaceStepMetaInterface
- Overrides:
getXML
in classBaseStepMeta
- Returns:
- String containing the XML describing this step.
-
readRep
public void readRep(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, org.pentaho.di.repository.ObjectId id_step, List<org.pentaho.di.core.database.DatabaseMeta> databases) throws org.pentaho.di.core.exception.KettleException Description copied from interface:StepMetaInterface
Read the steps information from a Kettle repository- Specified by:
readRep
in interfaceStepMetaInterface
- Overrides:
readRep
in classBaseStepMeta
- Parameters:
rep
- The repository to read frommetaStore
- The MetaStore to read external information fromid_step
- The step IDdatabases
- The databases to reference- Throws:
org.pentaho.di.core.exception.KettleException
- When an unexpected error occurred (database, network, etc)
-
saveRep
public void saveRep(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, org.pentaho.di.repository.ObjectId id_transformation, org.pentaho.di.repository.ObjectId id_step) throws org.pentaho.di.core.exception.KettleException Description copied from interface:StepMetaInterface
Save the steps data into a Kettle repository- Specified by:
saveRep
in interfaceStepMetaInterface
- Overrides:
saveRep
in classBaseStepMeta
- Parameters:
rep
- The Kettle repository to save tometaStore
- the metaStore to optionally write toid_transformation
- The transformation IDid_step
- The step ID- Throws:
org.pentaho.di.core.exception.KettleException
- When an unexpected error occurred (database, network, etc)
-
check
public void check(List<org.pentaho.di.core.CheckResultInterface> remarks, TransMeta transMeta, StepMeta stepMeta, org.pentaho.di.core.row.RowMetaInterface prev, String[] input, String[] output, org.pentaho.di.core.row.RowMetaInterface info, org.pentaho.di.core.variables.VariableSpace space, Repository repository, org.pentaho.metastore.api.IMetaStore metaStore) Description copied from interface:StepMetaInterface
Checks the settings of this step and puts the findings in a remarks List.- Specified by:
check
in interfaceStepMetaInterface
- Overrides:
check
in classBaseStepMeta
- Parameters:
remarks
- The list to put the remarks in @see org.pentaho.di.core.CheckResultstepMeta
- The stepMeta to help checkingprev
- The fields coming from the previous stepinput
- The input step namesoutput
- The output step namesinfo
- The fields that are used as information by the stepspace
- the variable space to resolve variable expressions withrepository
- the repository to use to load Kettle metadata objects impacting the output fieldsmetaStore
- the MetaStore to use to load additional external data or metadata impacting the output fields
-
getStep
public StepInterface getStep(StepMeta stepMeta, StepDataInterface stepDataInterface, int cnr, TransMeta tr, Trans trans) Description copied from interface:StepMetaInterface
Get the executing step, needed by Trans to launch a step.- Specified by:
getStep
in interfaceStepMetaInterface
- Parameters:
stepMeta
- The step infostepDataInterface
- the step data interface linked to this step. Here the step can store temporary data, database connections, etc.cnr
- The copy nr to gettr
- The transformation infotrans
- The launching transformation
-
getStepData
Description copied from interface:StepMetaInterface
Get a new instance of the appropriate data class. This data class implements the StepDataInterface. It basically contains the persisting data that needs to live on, even if a worker thread is terminated.- Specified by:
getStepData
in interfaceStepMetaInterface
- Returns:
- The appropriate StepDataInterface class.
-
analyseImpact
public void analyseImpact(List<DatabaseImpact> impact, TransMeta transMeta, StepMeta stepMeta, org.pentaho.di.core.row.RowMetaInterface prev, String[] input, String[] output, org.pentaho.di.core.row.RowMetaInterface info, Repository repository, org.pentaho.metastore.api.IMetaStore metaStore) throws org.pentaho.di.core.exception.KettleStepException Description copied from class:BaseStepMeta
Each step must be able to report on the impact it has on a database, table field, etc.- Specified by:
analyseImpact
in interfaceStepMetaInterface
- Overrides:
analyseImpact
in classBaseStepMeta
- Parameters:
impact
- The list of impacts @see org.pentaho.di.transMeta.DatabaseImpacttransMeta
- The transformation informationstepMeta
- The step informationprev
- The fields entering this stepinput
- The previous step namesoutput
- The output step namesinfo
- The fields used as information by this steprepository
- the repository to use to load Kettle metadata objects impacting the output fieldsmetaStore
- the MetaStore to use to load additional external data or metadata impacting the output fields- Throws:
org.pentaho.di.core.exception.KettleStepException
-
getUsedDatabaseConnections
public org.pentaho.di.core.database.DatabaseMeta[] getUsedDatabaseConnections()Description copied from class:BaseStepMeta
This method returns all the database connections that are used by the step.- Specified by:
getUsedDatabaseConnections
in interfaceStepMetaInterface
- Overrides:
getUsedDatabaseConnections
in classBaseStepMeta
- Returns:
- an array of database connections meta-data. Return an empty array if no connections are used.
-
supportsErrorHandling
public boolean supportsErrorHandling()- Specified by:
supportsErrorHandling
in interfaceStepMetaInterface
- Overrides:
supportsErrorHandling
in classBaseStepMeta
- Returns:
- true if this step supports error "reporting" on rows: the ability to send rows to a certain target step.
-