Package org.pentaho.di.trans.steps.update

Class UpdateMeta

    • Constructor Detail

      • UpdateMeta

        public UpdateMeta()

    • Method Detail

      • setConnection

        public void setConnection​(String connectionName)

      • getCommitSize

        @Deprecated
public int getCommitSize()
        Deprecated.
        use public String getCommitSizeVar() instead
        Returns:
        Returns the commitSize.

      • getCommitSizeVar

        public String getCommitSizeVar()
        Returns:
        Returns the commitSize.

      • getCommitSize

        public int getCommitSize​(org.pentaho.di.core.variables.VariableSpace vs)
        Parameters:
        vs - - variable space to be used for searching variable value usually "this" for a calling step
        Returns:
        Returns the commitSize.

      • setCommitSize

        @Deprecated
public void setCommitSize​(int commitSize)
        Deprecated.
        use public void setCommitSize( String commitSize ) instead
        Parameters:
        commitSize - The commitSize to set.

      • setCommitSize

        public void setCommitSize​(String commitSize)
        Parameters:
        commitSize - The commitSize to set.

      • isSkipLookup

        public boolean isSkipLookup()
        Returns:
        Returns the skipLookup.

      • setSkipLookup

        public void setSkipLookup​(boolean skipLookup)
        Parameters:
        skipLookup - The skipLookup to set.

      • getDatabaseMeta

        public org.pentaho.di.core.database.DatabaseMeta getDatabaseMeta()
        Specified by:
        getDatabaseMeta in class BaseDatabaseStepMeta
        Returns:
        Returns the database.

      • setDatabaseMeta

        public void setDatabaseMeta​(org.pentaho.di.core.database.DatabaseMeta database)
        Parameters:
        database - The database to set.

      • getKeyCondition

        public String[] getKeyCondition()
        Returns:
        Returns the keyCondition.

      • setKeyCondition

        public void setKeyCondition​(String[] keyCondition)
        Parameters:
        keyCondition - The keyCondition to set.

      • getKeyLookup

        public String[] getKeyLookup()
        Returns:
        Returns the keyLookup.

      • setKeyLookup

        public void setKeyLookup​(String[] keyLookup)
        Parameters:
        keyLookup - The keyLookup to set.

      • getKeyStream

        public String[] getKeyStream()
        Returns:
        Returns the keyStream.

      • setKeyStream

        public void setKeyStream​(String[] keyStream)
        Parameters:
        keyStream - The keyStream to set.

      • getKeyStream2

        public String[] getKeyStream2()
        Returns:
        Returns the keyStream2.

      • setKeyStream2

        public void setKeyStream2​(String[] keyStream2)
        Parameters:
        keyStream2 - The keyStream2 to set.

      • getTableName

        public String getTableName()
        Returns:
        Returns the tableName.

      • setTableName

        public void setTableName​(String tableName)
        Parameters:
        tableName - The tableName to set.

      • getUpdateLookup

        public String[] getUpdateLookup()
        Returns:
        Returns the updateLookup.

      • setUpdateLookup

        public void setUpdateLookup​(String[] updateLookup)
        Parameters:
        updateLookup - The updateLookup to set.

      • getUpdateStream

        public String[] getUpdateStream()
        Returns:
        Returns the updateStream.

      • setUpdateStream

        public void setUpdateStream​(String[] updateStream)
        Parameters:
        updateStream - The updateStream to set.

      • isErrorIgnored

        public boolean isErrorIgnored()
        Returns:
        Returns the ignoreError.

      • setErrorIgnored

        public void setErrorIgnored​(boolean ignoreError)
        Parameters:
        ignoreError - The ignoreError to set.

      • getIgnoreFlagField

        public String getIgnoreFlagField()
        Returns:
        Returns the ignoreFlagField.

      • setIgnoreFlagField

        public void setIgnoreFlagField​(String ignoreFlagField)
        Parameters:
        ignoreFlagField - The ignoreFlagField 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 interface StepMetaInterface
        Overrides:
        loadXML in class BaseStepMeta
        Parameters:
        stepnode - the Node to get the info from
        databases - The available list of databases to reference to
        metaStore - the metastore to optionally load external reference metadata from
        Throws:
        org.pentaho.di.core.exception.KettleXMLException - When an unexpected XML error occurred. (malformed etc.)

      • allocate

        public void allocate​(int nrkeys,
                     int nrvalues)

      • getXML

        public String getXML()
        Description copied from class: BaseStepMeta
        Produces the XML string that describes this step's information.
        Specified by:
        getXML in interface StepMetaInterface
        Overrides:
        getXML in class BaseStepMeta
        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 interface StepMetaInterface
        Overrides:
        readRep in class BaseStepMeta
        Parameters:
        rep - The repository to read from
        metaStore - The MetaStore to read external information from
        id_step - The step ID
        databases - 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 interface StepMetaInterface
        Overrides:
        saveRep in class BaseStepMeta
        Parameters:
        rep - The Kettle repository to save to
        metaStore - the metaStore to optionally write to
        id_transformation - The transformation ID
        id_step - The step ID
        Throws:
        org.pentaho.di.core.exception.KettleException - When an unexpected error occurred (database, network, etc)

      • 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 interface StepMetaInterface
        Overrides:
        getFields in class BaseStepMeta
        Parameters:
        row - the input row meta that is modified in this method to reflect the output row metadata of the step
        name - Name of the step to use as input for the origin field in the values
        info - Fields used as extra lookup information
        nextStep - the next step that is targeted
        space - the space The variable space to use to replace variables
        repository - the repository to use to load Kettle metadata objects impacting the output fields
        metaStore - 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

      • 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 interface StepMetaInterface
        Overrides:
        check in class BaseStepMeta
        Parameters:
        remarks - The list to put the remarks in @see org.pentaho.di.core.CheckResult
        stepMeta - The stepMeta to help checking
        prev - The fields coming from the previous step
        input - The input step names
        output - The output step names
        info - The fields that are used as information by the step
        space - the variable space to resolve variable expressions with
        repository - the repository to use to load Kettle metadata objects impacting the output fields
        metaStore - the MetaStore to use to load additional external data or metadata impacting the output fields

      • getSQLStatements

        public 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)
                                                  throws org.pentaho.di.core.exception.KettleStepException
        Description copied from class: BaseStepMeta
        Standard method to return an SQLStatement object with SQL statements that the step needs in order to work correctly. This can mean "create table", "create index" statements but also "alter table ... add/drop/modify" statements.
        Specified by:
        getSQLStatements in interface StepMetaInterface
        Overrides:
        getSQLStatements in class BaseStepMeta
        Parameters:
        transMeta - TransInfo object containing the complete transformation
        stepMeta - StepMeta object containing the complete step
        prev - Row containing meta-data for the input fields (no data)
        repository - the repository to use to load Kettle metadata objects impacting the output fields
        metaStore - the MetaStore to use to load additional external data or metadata impacting the output fields
        Returns:
        The SQL Statements for this step. If nothing has to be done, the SQLStatement.getSQL() == null. @see SQLStatement
        Throws:
        org.pentaho.di.core.exception.KettleStepException

      • 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 interface StepMetaInterface
        Overrides:
        analyseImpact in class BaseStepMeta
        Parameters:
        impact - The list of impacts @see org.pentaho.di.transMeta.DatabaseImpact
        transMeta - The transformation information
        stepMeta - The step information
        prev - The fields entering this step
        input - The previous step names
        output - The output step names
        info - The fields used as information by this step
        repository - the repository to use to load Kettle metadata objects impacting the output fields
        metaStore - the MetaStore to use to load additional external data or metadata impacting the output fields
        Throws:
        org.pentaho.di.core.exception.KettleStepException

      • 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 interface StepMetaInterface
        Parameters:
        stepMeta - The step info
        stepDataInterface - the step data interface linked to this step. Here the step can store temporary data, database connections, etc.
        cnr - The copy nr to get
        tr - The transformation info
        trans - The launching transformation

      • getStepData

        public StepDataInterface 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 interface StepMetaInterface
        Returns:
        The appropriate StepDataInterface class.

      • 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 interface StepMetaInterface
        Overrides:
        getUsedDatabaseConnections in class BaseStepMeta
        Returns:
        an array of database connections meta-data. Return an empty array if no connections are used.

      • getSchemaName

        public String getSchemaName()
        Returns:
        the schemaName

      • setSchemaName

        public void setSchemaName​(String schemaName)
        Parameters:
        schemaName - the schemaName to set

      • useBatchUpdate

        public boolean useBatchUpdate()
        Returns:
        the useBatchUpdate

      • setUseBatchUpdate

        public void setUseBatchUpdate​(boolean useBatchUpdate)
        Parameters:
        useBatchUpdate - the useBatchUpdate to set

      • afterInjectionSynchronization

        public void afterInjectionSynchronization()
        If we use injection we can have different arrays lengths. We need synchronize them for consistency behavior with UI