Package org.pentaho.di.core

Interface TableManager

  • public interface TableManager
    An interface for transformation steps that manage loading data into a database table (or other storage system). For example a table output step or a bulk loader. This interface is used by the Agile BI plugin to determine which steps it can manipulate during loading of data.
    Author:
    jamesdixon

    • Method Detail

      • setTableName

        void setTableName​(String tableName)
        Sets the table name. If the name of the database table is determined programatically this method can be used to set the table name.
        Parameters:
        tableName -

      • flush

        boolean flush()
        Flushes the current in-memory buffer to the storage system. This is called during cancel operations when the current set of data is still wanted.
        Returns:
        true if the operation succeeded

      • dropTable

        boolean dropTable()
        Drops the current table. This is used during management operations.
        Returns:
        true if the operation succeeded

      • setRowLimit

        void setRowLimit​(long rowLimit)
        Sets the row limit. This is used to limit the data loaded during a specific execution. This value might change every time the transformation is executed.
        Parameters:
        rowLimit -

      • truncateTable

        boolean truncateTable()
        Truncates the current table. This is used during management operations.
        Returns:
        true if the operation succeeded

      • adjustSchema

        boolean adjustSchema()
        Adjust schema. This is used to change the schema when the input fields change.
        Returns:
        true if the operation succeeded

      • getMessage

        String getMessage()
        Returns a human-readable message about any errors that have occurred. If any of the operations (dropTable, flush, truncateTable) fail, this method should return a nice, accurate message describing the problem that was encountered.
        Returns: