public class TableOutputMeta extends BaseStepMeta implements StepMetaInterface, ProvidesModelerMeta
loggingObject, STEP_ATTRIBUTES_FILE
Constructor and Description |
---|
TableOutputMeta() |
Modifier and Type | Method and Description |
---|---|
void |
allocate(int nrRows) |
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)
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.
|
Object |
clone()
Make an exact copy of this step, make sure to explicitly copy Collections etc.
|
List<StepInjectionMetaEntry> |
extractStepMetadataEntries() |
String |
getCommitSize() |
List<String> |
getDatabaseFields() |
org.pentaho.di.core.database.DatabaseMeta |
getDatabaseMeta()
Returns the database meta for this step
|
String[] |
getFieldDatabase() |
void |
getFields(org.pentaho.di.core.row.RowMetaInterface row,
String origin,
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.
|
String[] |
getFieldStream() |
String |
getGeneratedKeyField() |
String |
getMissingDatabaseConnectionInformationMessage()
Provides a way for this object to return a custom message when database connection information is incomplete or
missing.
|
String |
getPartitioningField() |
org.pentaho.di.core.row.RowMetaInterface |
getRequiredFields(org.pentaho.di.core.variables.VariableSpace space)
The natural way of data flow in a transformation is source-to-target.
|
org.pentaho.di.core.row.RowMeta |
getRowMeta(StepDataInterface stepData) |
String |
getSchemaName()
Returns the schema name for this step.
|
org.pentaho.di.core.SQLStatement |
getSQLStatements(TransMeta transMeta,
StepMeta stepMeta,
org.pentaho.di.core.row.RowMetaInterface prev,
Repository repository,
org.pentaho.metastore.api.IMetaStore metaStore)
Standard method to return an SQLStatement object with SQL statements that the step needs in order to work
correctly.
|
org.pentaho.di.core.SQLStatement |
getSQLStatements(TransMeta transMeta,
StepMeta stepMeta,
org.pentaho.di.core.row.RowMetaInterface prev,
String tk,
boolean use_autoinc,
String pk) |
StepInterface |
getStep(StepMeta stepMeta,
StepDataInterface stepDataInterface,
int cnr,
TransMeta transMeta,
Trans trans)
Get the executing step, needed by Trans to launch a step.
|
StepDataInterface |
getStepData()
Get a new instance of the appropriate data class.
|
TableOutputMetaInjection |
getStepMetaInjectionInterface() |
List<String> |
getStreamFields() |
String |
getTablename()
Deprecated.
Use
getTableName() |
String |
getTableName()
Returns the table name for this step
|
String |
getTableNameField() |
org.pentaho.di.core.database.DatabaseMeta[] |
getUsedDatabaseConnections()
This method returns all the database connections that are used by the step.
|
String |
getXML()
Produces the XML string that describes this step's information.
|
boolean |
ignoreErrors() |
boolean |
isPartitioningDaily() |
boolean |
isPartitioningEnabled() |
boolean |
isPartitioningMonthly() |
boolean |
isReturningGeneratedKeys() |
boolean |
isTableNameInField() |
boolean |
isTableNameInTable() |
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 Node
|
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)
Read the steps information from a Kettle repository
|
void |
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 repository
|
void |
setCommitSize(int commitSizeInt) |
void |
setCommitSize(String commitSize) |
void |
setDatabaseMeta(org.pentaho.di.core.database.DatabaseMeta database) |
void |
setDefault()
Set default values
|
void |
setFieldDatabase(String[] fieldDatabase) |
void |
setFieldStream(String[] fieldStream) |
void |
setGeneratedKeyField(String generatedKeyField) |
void |
setIgnoreErrors(boolean ignoreErrors) |
void |
setPartitioningDaily(boolean partitioningDaily) |
void |
setPartitioningEnabled(boolean partitioningEnabled) |
void |
setPartitioningField(String partitioningField) |
void |
setPartitioningMonthly(boolean partitioningMontly) |
void |
setReturningGeneratedKeys(boolean returningGeneratedKeys) |
void |
setSchemaName(String schemaName) |
void |
setSpecifyFields(boolean specifyFields) |
void |
setTablename(String tablename)
Deprecated.
|
void |
setTableName(String tableName)
Assign the table name to write to.
|
void |
setTableNameField(String tableNameField) |
void |
setTableNameInField(boolean tableNameInField) |
void |
setTableNameInTable(boolean tableNameInTable) |
void |
setTruncateTable(boolean truncateTable) |
void |
setUseBatchUpdate(boolean useBatchUpdate) |
boolean |
specifyFields() |
boolean |
supportsErrorHandling() |
boolean |
truncateTable() |
boolean |
useBatchUpdate() |
analyseImpact, cancelQueries, check, check, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, exportResources, exportResources, findAttribute, findParent, getActiveReferencedObjectDescription, getDescription, getDialogClassName, getFields, getLog, getLogChannelId, getName, getObjectCopy, getObjectId, getObjectRevision, getObjectType, getOptionalStreams, getParent, getParentStepMeta, getReferencedObjectDescriptions, getRepCode, getRepositoryDirectory, getRequiredFields, getResourceDependencies, getSQLStatements, getStepInjectionMetadataEntries, getStepIOMeta, getSupportedTransformationTypes, getTableFields, getTooltip, getUsedArguments, getUsedLibraries, getXmlCode, handleStreamSelection, hasChanged, hasRepositoryReferences, isBasic, isDebug, isDetailed, isReferencedObjectEnabled, isRowLevel, loadReferencedObject, loadReferencedObject, loadXML, loadXML, logBasic, logBasic, logDebug, logDebug, logDetailed, logDetailed, logError, logError, logError, logMinimal, logMinimal, logRowlevel, logRowlevel, lookupRepositoryReferences, readRep, readRep, resetStepIoMeta, saveRep, searchInfoAndTargetSteps, setChanged, setChanged, setParentStepMeta
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
analyseImpact, cancelQueries, check, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, exportResources, exportResources, getActiveReferencedObjectDescription, getDialogClassName, getFields, getOptionalStreams, getParentStepMeta, getReferencedObjectDescriptions, getResourceDependencies, getSQLStatements, getStepIOMeta, getSupportedTransformationTypes, getTableFields, getUsedArguments, getUsedLibraries, handleStreamSelection, hasChanged, hasRepositoryReferences, isReferencedObjectEnabled, loadReferencedObject, loadXML, lookupRepositoryReferences, readRep, resetStepIoMeta, saveRep, searchInfoAndTargetSteps, setChanged, setParentStepMeta
public String getGeneratedKeyField()
public void setGeneratedKeyField(String generatedKeyField)
generatedKeyField
- The generatedKeyField to set.public boolean isReturningGeneratedKeys()
public void setReturningGeneratedKeys(boolean returningGeneratedKeys)
returningGeneratedKeys
- The returningGeneratedKeys to set.public boolean isTableNameInTable()
public void setTableNameInTable(boolean tableNameInTable)
tableNameInTable
- The tableNameInTable to set.public String getTableNameField()
public void setTableNameField(String tableNameField)
tableNameField
- The tableNameField to set.public boolean isTableNameInField()
public void setTableNameInField(boolean tableNameInField)
tableNameInField
- The tableNameInField to set.public boolean isPartitioningDaily()
public void setPartitioningDaily(boolean partitioningDaily)
partitioningDaily
- The partitioningDaily to set.public boolean isPartitioningMonthly()
public void setPartitioningMonthly(boolean partitioningMontly)
partitioningMontly
- The partitioningMontly to set.public boolean isPartitioningEnabled()
public void setPartitioningEnabled(boolean partitioningEnabled)
partitioningEnabled
- The partitioningEnabled to set.public String getPartitioningField()
public void setPartitioningField(String partitioningField)
partitioningField
- The partitioningField to set.public void allocate(int nrRows)
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
StepMetaInterface
loadXML
in interface StepMetaInterface
loadXML
in class BaseStepMeta
stepnode
- the Node to get the info fromdatabases
- The available list of databases to reference tometaStore
- the metastore to optionally load external reference metadata fromorg.pentaho.di.core.exception.KettleXMLException
- When an unexpected XML error occurred. (malformed etc.)public Object clone()
StepMetaInterface
clone
in interface StepMetaInterface
clone
in class BaseStepMeta
public org.pentaho.di.core.database.DatabaseMeta getDatabaseMeta()
ProvidesDatabaseConnectionInformation
getDatabaseMeta
in interface ProvidesDatabaseConnectionInformation
public void setDatabaseMeta(org.pentaho.di.core.database.DatabaseMeta database)
database
- The database to set.public String getCommitSize()
public void setCommitSize(int commitSizeInt)
commitSize
- The commitSize to set.public void setCommitSize(String commitSize)
commitSize
- The commitSize to set.public String getTableName()
ProvidesDatabaseConnectionInformation
getTableName
in interface ProvidesDatabaseConnectionInformation
public void setTableName(String tableName)
tableName
- The table name to set@Deprecated public String getTablename()
getTableName()
@Deprecated public void setTablename(String tablename)
setTableName(String)
tablename
- The tablename to set.public boolean truncateTable()
public void setTruncateTable(boolean truncateTable)
truncateTable
- The truncate table flag to set.public void setIgnoreErrors(boolean ignoreErrors)
ignoreErrors
- The ignore errors flag to set.public boolean ignoreErrors()
public void setSpecifyFields(boolean specifyFields)
specifyFields
- The specify fields flag to set.public boolean specifyFields()
public void setUseBatchUpdate(boolean useBatchUpdate)
useBatchUpdate
- The useBatchUpdate flag to set.public boolean useBatchUpdate()
public void setDefault()
StepMetaInterface
setDefault
in interface StepMetaInterface
public String getXML()
BaseStepMeta
getXML
in interface StepMetaInterface
getXML
in class BaseStepMeta
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
StepMetaInterface
readRep
in interface StepMetaInterface
readRep
in class BaseStepMeta
rep
- The repository to read frommetaStore
- The MetaStore to read external information fromid_step
- The step IDdatabases
- The databases to referenceorg.pentaho.di.core.exception.KettleException
- When an unexpected error occurred (database, network, etc)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
StepMetaInterface
saveRep
in interface StepMetaInterface
saveRep
in class BaseStepMeta
rep
- The Kettle repository to save tometaStore
- the metaStore to optionally write toid_transformation
- The transformation IDid_step
- The step IDorg.pentaho.di.core.exception.KettleException
- When an unexpected error occurred (database, network, etc)public void getFields(org.pentaho.di.core.row.RowMetaInterface row, String origin, 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
BaseStepMeta
getFields
in interface StepMetaInterface
getFields
in class BaseStepMeta
row
- the input row meta that is modified in this method to reflect the output row metadata of the steporigin
- 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 fieldsorg.pentaho.di.core.exception.KettleStepException
- the kettle step exceptionpublic 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)
StepMetaInterface
check
in interface StepMetaInterface
check
in class BaseStepMeta
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 fieldspublic StepInterface getStep(StepMeta stepMeta, StepDataInterface stepDataInterface, int cnr, TransMeta transMeta, Trans trans)
StepMetaInterface
getStep
in interface StepMetaInterface
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 gettransMeta
- The transformation infotrans
- The launching transformationpublic StepDataInterface getStepData()
StepMetaInterface
getStepData
in interface StepMetaInterface
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)
BaseStepMeta
analyseImpact
in interface StepMetaInterface
analyseImpact
in class BaseStepMeta
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 fieldspublic org.pentaho.di.core.SQLStatement getSQLStatements(TransMeta transMeta, StepMeta stepMeta, org.pentaho.di.core.row.RowMetaInterface prev, Repository repository, org.pentaho.metastore.api.IMetaStore metaStore)
BaseStepMeta
getSQLStatements
in interface StepMetaInterface
getSQLStatements
in class BaseStepMeta
transMeta
- TransInfo object containing the complete transformationstepMeta
- StepMeta object containing the complete stepprev
- Row containing meta-data for the input fields (no data)repository
- 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 fieldspublic org.pentaho.di.core.SQLStatement getSQLStatements(TransMeta transMeta, StepMeta stepMeta, org.pentaho.di.core.row.RowMetaInterface prev, String tk, boolean use_autoinc, String pk)
public org.pentaho.di.core.row.RowMetaInterface getRequiredFields(org.pentaho.di.core.variables.VariableSpace space) throws org.pentaho.di.core.exception.KettleException
BaseStepMeta
getRequiredFields
in interface StepMetaInterface
getRequiredFields
in class BaseStepMeta
space
- the variable space to use to do variable substitution.org.pentaho.di.core.exception.KettleException
- in case the required fields can't be determinedpublic org.pentaho.di.core.database.DatabaseMeta[] getUsedDatabaseConnections()
BaseStepMeta
getUsedDatabaseConnections
in interface StepMetaInterface
getUsedDatabaseConnections
in class BaseStepMeta
public String[] getFieldStream()
public void setFieldStream(String[] fieldStream)
fieldStream
- The fields containing the values in the input stream to insert in the table.public org.pentaho.di.core.row.RowMeta getRowMeta(StepDataInterface stepData)
getRowMeta
in interface ProvidesModelerMeta
public List<String> getDatabaseFields()
getDatabaseFields
in interface ProvidesModelerMeta
public List<String> getStreamFields()
getStreamFields
in interface ProvidesModelerMeta
public String[] getFieldDatabase()
public void setFieldDatabase(String[] fieldDatabase)
fieldDatabase
- The fields containing the names of the fields to insert.public String getSchemaName()
ProvidesDatabaseConnectionInformation
getSchemaName
in interface ProvidesDatabaseConnectionInformation
public void setSchemaName(String schemaName)
schemaName
- the schemaName to setpublic boolean supportsErrorHandling()
supportsErrorHandling
in interface StepMetaInterface
supportsErrorHandling
in class BaseStepMeta
public String getMissingDatabaseConnectionInformationMessage()
ProvidesDatabaseConnectionInformation
null
a default message will be displayed for missing information.getMissingDatabaseConnectionInformationMessage
in interface ProvidesDatabaseConnectionInformation
public TableOutputMetaInjection getStepMetaInjectionInterface()
getStepMetaInjectionInterface
in interface StepMetaInterface
getStepMetaInjectionInterface
in class BaseStepMeta
public List<StepInjectionMetaEntry> extractStepMetadataEntries() throws org.pentaho.di.core.exception.KettleException
extractStepMetadataEntries
in interface StepMetaInterface
extractStepMetadataEntries
in class BaseStepMeta
org.pentaho.di.core.exception.KettleException