Package org.pentaho.di.job.entries.sql

Class JobEntrySQL

java.lang.Object
org.pentaho.di.job.entry.JobEntryBase
org.pentaho.di.job.entries.sql.JobEntrySQL
All Implemented Interfaces:
Cloneable, org.pentaho.di.core.AttributesInterface, org.pentaho.di.core.CheckResultSourceInterface, org.pentaho.di.core.ExtensionDataInterface, org.pentaho.di.core.logging.LoggingObjectInterface, org.pentaho.di.core.logging.LoggingObjectLifecycleInterface, org.pentaho.di.core.variables.VariableSpace, JobEntryInterface, ResourceHolderInterface
public class JobEntrySQL extends JobEntryBase implements Cloneable, JobEntryInterface
This defines an SQL job entry.
Since:
05-11-2003
Author:
Matt

  • Field Details

  • Constructor Details

    • JobEntrySQL

      public JobEntrySQL(String n)

    • JobEntrySQL

      public JobEntrySQL()

  • Method Details

    • clone

      public Object clone()
      Description copied from class: JobEntryBase
      This method is called when a job entry is duplicated in Spoon. It needs to return a deep copy of this job entry object. It is essential that the implementing class creates proper deep copies if the job entry configuration is stored in modifiable objects, such as lists or custom helper objects.
      Specified by:
      clone in interface JobEntryInterface
      Overrides:
      clone in class JobEntryBase
      Returns:
      a clone of the object

    • getXML

      public String getXML()
      Description copied from class: JobEntryBase
      This method is called by PDI whenever a job entry needs to serialize its settings to XML. It is called when saving a job in Spoon. The method returns an XML string, containing the serialized settings. The string contains a series of XML tags, typically one tag per setting. The helper class org.pentaho.di.core.xml.XMLHandler is typically used to construct the XML string.
      Specified by:
      getXML in interface JobEntryInterface
      Overrides:
      getXML in class JobEntryBase
      Returns:
      the xml representation of the job entry

    • loadXML

      public void loadXML(Node entrynode, List<org.pentaho.di.core.database.DatabaseMeta> databases, List<SlaveServer> slaveServers, Repository rep, org.pentaho.metastore.api.IMetaStore metaStore) throws org.pentaho.di.core.exception.KettleXMLException
      Description copied from interface: JobEntryInterface
      This method is called by PDI whenever a job entry needs to read its settings from XML. The XML node containing the job entry's settings is passed in as an argument. Again, the helper class org.pentaho.di.core.xml.XMLHandler is typically used to conveniently read the settings from the XML node.
      Specified by:
      loadXML in interface JobEntryInterface
      Overrides:
      loadXML in class JobEntryBase
      Parameters:
      entrynode - the top-level XML node
      databases - the list of databases
      slaveServers - the list of slave servers
      rep - the repository object
      metaStore - The metaStore to optionally load from.
      Throws:
      org.pentaho.di.core.exception.KettleXMLException - if any errors occur during the loading of the XML

    • loadRep

      public void loadRep(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, org.pentaho.di.repository.ObjectId idJobentry, List<org.pentaho.di.core.database.DatabaseMeta> databases, List<SlaveServer> slaveServers) throws org.pentaho.di.core.exception.KettleException
      Description copied from interface: JobEntryInterface
      This method is called by PDI whenever a job entry needs to read its configuration from a PDI repository. The job entry id given in the arguments should be used as the identifier when using the repository's serialization methods.
      Specified by:
      loadRep in interface JobEntryInterface
      Overrides:
      loadRep in class JobEntryBase
      Parameters:
      rep - the repository object
      metaStore - the MetaStore to use
      idJobentry - the id of the job entry
      databases - the list of databases
      slaveServers - the list of slave servers
      Throws:
      org.pentaho.di.core.exception.KettleException - if any errors occur during the load

    • saveRep

      public void saveRep(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, org.pentaho.di.repository.ObjectId idJob) throws org.pentaho.di.core.exception.KettleException
      Description copied from interface: JobEntryInterface
      This method is called by PDI whenever a job entry needs to save its settings to a PDI repository. The repository object passed in as the first argument provides a convenient set of methods for serializing job entry settings. When calling repository serialization methods, job id and job entry id are required. The job id is passed in to saveRep() as an argument, and the job entry id can be obtained by a call to getObjectId() inherited from the base class.
      Specified by:
      saveRep in interface JobEntryInterface
      Overrides:
      saveRep in class JobEntryBase
      Parameters:
      rep - the repository
      metaStore - the MetaStore to use
      idJob - the id_job
      Throws:
      org.pentaho.di.core.exception.KettleException - if any errors occur during the save

    • setSQL

      public void setSQL(String sql)

    • getSQL

      public String getSQL()

    • getSQLFilename

      public String getSQLFilename()

    • setSQLFilename

      public void setSQLFilename(String sqlFilename)

    • getUseVariableSubstitution

      public boolean getUseVariableSubstitution()

    • setUseVariableSubstitution

      public void setUseVariableSubstitution(boolean subs)

    • setSQLFromFile

      public void setSQLFromFile(boolean sqlFromFileIn)

    • getSQLFromFile

      public boolean getSQLFromFile()

    • isSendOneStatement

      public boolean isSendOneStatement()

    • setSendOneStatement

      public void setSendOneStatement(boolean sendOneStatementIn)

    • setDatabase

      public void setDatabase(org.pentaho.di.core.database.DatabaseMeta database)

    • getDatabase

      public org.pentaho.di.core.database.DatabaseMeta getDatabase()

    • execute

      public org.pentaho.di.core.Result execute(org.pentaho.di.core.Result result, int nr)
      Description copied from interface: JobEntryInterface
      Execute the job entry. The previous result and number of rows are provided to the method for the purpose of chaining job entries, transformations, etc.
      Specified by:
      execute in interface JobEntryInterface
      Parameters:
      result - the previous result
      nr - the number of rows
      Returns:
      the Result object from execution of this job entry

    • buildSqlFromFile

      public String buildSqlFromFile() throws org.pentaho.di.core.exception.KettleDatabaseException
      Throws:
      org.pentaho.di.core.exception.KettleDatabaseException

    • evaluates

      public boolean evaluates()
      Description copied from class: JobEntryBase
      This method must return true if the job entry supports the true/false outgoing hops. For JobEntryBase, this method always returns false
      Specified by:
      evaluates in interface JobEntryInterface
      Overrides:
      evaluates in class JobEntryBase
      Returns:
      false

    • isUnconditional

      public boolean isUnconditional()
      Description copied from class: JobEntryBase
      This method must return true if the job entry supports the unconditional outgoing hop. For JobEntryBase, this method always returns true
      Specified by:
      isUnconditional in interface JobEntryInterface
      Overrides:
      isUnconditional in class JobEntryBase
      Returns:
      true

    • getUsedDatabaseConnections

      public org.pentaho.di.core.database.DatabaseMeta[] getUsedDatabaseConnections()
      Description copied from class: JobEntryBase
      Gets all the database connections that are used by the job entry. For JobEntryBase, this method returns an empty (non-null) array
      Specified by:
      getUsedDatabaseConnections in interface JobEntryInterface
      Overrides:
      getUsedDatabaseConnections in class JobEntryBase
      Returns:
      an empty (non-null) array

    • getResourceDependencies

      public List<ResourceReference> getResourceDependencies(JobMeta jobMeta)
      Description copied from class: JobEntryBase
      Gets a list of all the resource dependencies that the step is depending on. In JobEntryBase, this method returns an empty resource dependency list.
      Specified by:
      getResourceDependencies in interface JobEntryInterface
      Overrides:
      getResourceDependencies in class JobEntryBase
      Returns:
      an empty list of ResourceReferences
      See Also:

    • check

      public void check(List<org.pentaho.di.core.CheckResultInterface> remarks, JobMeta jobMeta, org.pentaho.di.core.variables.VariableSpace space, Repository repository, org.pentaho.metastore.api.IMetaStore metaStore)
      Description copied from class: JobEntryBase
      Allows JobEntry objects to check themselves for consistency
      Specified by:
      check in interface JobEntryInterface
      Overrides:
      check in class JobEntryBase
      Parameters:
      remarks - List of CheckResult objects indicating consistency status
      jobMeta - the metadata object for the job entry
      space - the variable space to resolve string expressions with variables with
      repository - the repository to load Kettle objects from
      metaStore - the MetaStore to load common elements from