Class JobEntryMssqlBulkLoad
java.lang.Object
org.pentaho.di.job.entry.JobEntryBase
org.pentaho.di.job.entries.mssqlbulkload.JobEntryMssqlBulkLoad
- 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
This defines a MSSQL Bulk job entry.
- Since:
- Jan-2007
- Author:
- Samatar Hassan
-
Field Summary
Fields inherited from class org.pentaho.di.job.entry.JobEntryBase
attributesMap, containerObjectId, entryStepSetVariablesMap, extensionDataMap, log, metaStore, parentJob, parentJobMeta, rep, variables
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
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) Allows JobEntry objects to check themselves for consistencyclone()
This method is called when a job entry is duplicated in Spoon.boolean
This method must return true if the job entry supports the true/false outgoing hops.org.pentaho.di.core.Result
execute
(org.pentaho.di.core.Result previousResult, int nr) Execute the job entry.int
org.pentaho.di.core.database.DatabaseMeta
int
Gets the filename of the job entry.int
getResourceDependencies
(JobMeta jobMeta) Gets a list of all the resource dependencies that the step is depending on.int
int
org.pentaho.di.core.database.DatabaseMeta[]
Gets all the database connections that are used by the job entry.getXML()
This method is called by PDI whenever a job entry needs to serialize its settings to XML.boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
This method must return true if the job entry supports the unconditional outgoing hop.void
loadRep
(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, org.pentaho.di.repository.ObjectId id_jobentry, List<org.pentaho.di.core.database.DatabaseMeta> databases, List<SlaveServer> slaveServers) This method is called by PDI whenever a job entry needs to read its configuration from a PDI repository.void
loadXML
(Node entrynode, List<org.pentaho.di.core.database.DatabaseMeta> databases, List<SlaveServer> slaveServers, Repository rep, org.pentaho.metastore.api.IMetaStore metaStore) This method is called by PDI whenever a job entry needs to read its settings from XML.void
saveRep
(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, org.pentaho.di.repository.ObjectId id_job) This method is called by PDI whenever a job entry needs to save its settings to a PDI repository.void
setAddDatetime
(boolean adddatetime) void
setAddFileToResult
(boolean addfiletoresultin) void
setBatchSize
(int batchsize) void
setCheckConstraints
(boolean checkconstraints) void
setCodePage
(String codepage) void
setDatabase
(org.pentaho.di.core.database.DatabaseMeta database) void
setDataFileType
(String datafiletype) void
setEndFile
(int endfile) void
setErrorFilename
(String errorfilename) void
setFieldTerminator
(String fieldterminator) void
setFilename
(String filename) void
setFireTriggers
(boolean firetriggers) void
setFormatFilename
(String formatfilename) void
setKeepIdentity
(boolean keepidentity) void
setKeepNulls
(boolean keepnulls) void
setLineterminated
(String lineterminated) void
setMaxErrors
(int maxerrors) void
setOrderBy
(String orderby) void
setOrderDirection
(String orderdirection) void
setRowsPerBatch
(int rowsperbatch) void
setSchemaname
(String schemaname) void
setSpecificCodePage
(String specificcodepage) void
setStartFile
(int startfile) void
setTablename
(String tablename) void
setTablock
(boolean tablock) void
setTruncate
(boolean truncate) Methods inherited from class org.pentaho.di.job.entry.JobEntryBase
addDatetimeToFilename, check, clear, copyVariablesFrom, environmentSubstitute, environmentSubstitute, equals, exportResources, exportResources, fieldSubstitute, getAttribute, getAttributes, getAttributesMap, getBooleanValueOfVariable, getContainerObjectId, getDescription, getDialogClassName, getEntryStepSetVariable, getEntryStepSetVariablesMap, getExtensionDataMap, getHolderType, getLogChannel, getLogChannelId, getLogLevel, getMetaStore, getName, getObjectCopy, getObjectId, getObjectName, getObjectRevision, getObjectType, getParent, getParentJob, getParentJobMeta, getParentVariableSpace, getPluginId, getRealFilename, getReferencedObjectDescriptions, getRegistrationDate, getRepository, getRepositoryDirectory, getSQLStatements, getSQLStatements, getSQLStatements, getTypeDesc, getTypeId, getVariable, getVariable, getVariables, hasChanged, hashCode, hasRepositoryReferences, initializeVariablesFrom, injectVariables, isBasic, isDebug, isDetailed, isDummy, isEvaluation, isForcingSeparateLogging, isFTP, isGatheringMetrics, isHTTP, isJob, isMail, isReferencedObjectEnabled, isRowlevel, isSFTP, isShell, isSpecial, isStart, isTransformation, listVariables, loadReferencedObject, loadReferencedObject, loadRep, loadXML, loadXML, logBasic, logBasic, logDebug, logDebug, logDetailed, logDetailed, logError, logError, logError, logMinimal, logMinimal, logRowlevel, logRowlevel, lookupRepositoryReferences, parseRepositoryObjects, resetErrorsBeforeExecution, saveRep, setAttribute, setAttributes, setAttributesMap, setChanged, setChanged, setContainerObjectId, setDescription, setEntryStepSetVariable, setForcingSeparateLogging, setGatheringMetrics, setID, setLogLevel, setMetaStore, setName, setObjectId, setParentJob, setParentJobMeta, setParentVariableSpace, setPluginId, setRepository, setTypeId, setVariable, shareVariablesWith, toString
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.pentaho.di.job.entry.JobEntryInterface
check, clear, exportResources, exportResources, getDescription, getDialogClassName, getLogChannel, getName, getObjectId, getParentJob, getParentJobMeta, getPluginId, getRealFilename, getReferencedObjectDescriptions, getSQLStatements, getSQLStatements, getSQLStatements, getTypeId, hasChanged, hasRepositoryReferences, isDummy, isEvaluation, isJob, isMail, isReferencedObjectEnabled, isShell, isSpecial, isStart, isTransformation, loadReferencedObject, loadReferencedObject, loadRep, loadXML, lookupRepositoryReferences, resetErrorsBeforeExecution, saveRep, setChanged, setChanged, setDescription, setMetaStore, setName, setObjectId, setParentJob, setParentJobMeta, setPluginId, setRepository
Methods inherited from interface org.pentaho.di.core.logging.LoggingObjectLifecycleInterface
callAfterLog, callBeforeLog
Methods inherited from interface org.pentaho.di.core.variables.VariableSpace
environmentSubstitute
-
Constructor Details
-
JobEntryMssqlBulkLoad
-
JobEntryMssqlBulkLoad
public JobEntryMssqlBulkLoad()
-
-
Method Details
-
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 interfaceJobEntryInterface
- Overrides:
clone
in classJobEntryBase
- Returns:
- a clone of the object
-
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 interfaceJobEntryInterface
- Overrides:
getXML
in classJobEntryBase
- 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 interfaceJobEntryInterface
- Overrides:
loadXML
in classJobEntryBase
- Parameters:
entrynode
- the top-level XML nodedatabases
- the list of databasesslaveServers
- the list of slave serversrep
- the repository objectmetaStore
- 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 id_jobentry, 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 interfaceJobEntryInterface
- Overrides:
loadRep
in classJobEntryBase
- Parameters:
rep
- the repository objectmetaStore
- the MetaStore to useid_jobentry
- the id of the job entrydatabases
- the list of databasesslaveServers
- 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 id_job) 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 interfaceJobEntryInterface
- Overrides:
saveRep
in classJobEntryBase
- Parameters:
rep
- the repositorymetaStore
- the MetaStore to useid_job
- the id_job- Throws:
org.pentaho.di.core.exception.KettleException
- if any errors occur during the save
-
setTablename
-
setSchemaname
-
getSchemaname
-
getTablename
-
setMaxErrors
public void setMaxErrors(int maxerrors) -
getMaxErrors
public int getMaxErrors() -
getBatchSize
public int getBatchSize() -
setBatchSize
public void setBatchSize(int batchsize) -
getRowsPerBatch
public int getRowsPerBatch() -
setRowsPerBatch
public void setRowsPerBatch(int rowsperbatch) -
setDatabase
public void setDatabase(org.pentaho.di.core.database.DatabaseMeta database) -
getDatabase
public org.pentaho.di.core.database.DatabaseMeta getDatabase() -
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 interfaceJobEntryInterface
- Overrides:
evaluates
in classJobEntryBase
- 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 interfaceJobEntryInterface
- Overrides:
isUnconditional
in classJobEntryBase
- Returns:
- true
-
execute
public org.pentaho.di.core.Result execute(org.pentaho.di.core.Result previousResult, 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 interfaceJobEntryInterface
- Parameters:
previousResult
- the previous resultnr
- the number of rows- Returns:
- the Result object from execution of this job entry
-
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 interfaceJobEntryInterface
- Overrides:
getUsedDatabaseConnections
in classJobEntryBase
- Returns:
- an empty (non-null) array
-
setFilename
-
getFilename
Description copied from class:JobEntryBase
Gets the filename of the job entry. For JobEntryBase, this method always returns null- Specified by:
getFilename
in interfaceJobEntryInterface
- Specified by:
getFilename
in interfaceorg.pentaho.di.core.logging.LoggingObjectInterface
- Overrides:
getFilename
in classJobEntryBase
- Returns:
- null
- See Also:
-
LoggingObjectInterface.getFilename()
-
setFieldTerminator
-
setLineterminated
-
setCodePage
-
getCodePage
-
setSpecificCodePage
-
getSpecificCodePage
-
setFormatFilename
-
getFormatFilename
-
getFieldTerminator
-
getLineterminated
-
getDataFileType
-
setDataFileType
-
getRealLineterminated
-
getRealFieldTerminator
-
setStartFile
public void setStartFile(int startfile) -
getStartFile
public int getStartFile() -
setEndFile
public void setEndFile(int endfile) -
getEndFile
public int getEndFile() -
setOrderBy
-
getOrderBy
-
getOrderDirection
-
setOrderDirection
-
setErrorFilename
-
getErrorFilename
-
getRealOrderBy
-
setAddFileToResult
public void setAddFileToResult(boolean addfiletoresultin) -
isAddFileToResult
public boolean isAddFileToResult() -
setTruncate
public void setTruncate(boolean truncate) -
isTruncate
public boolean isTruncate() -
setAddDatetime
public void setAddDatetime(boolean adddatetime) -
isAddDatetime
public boolean isAddDatetime() -
setFireTriggers
public void setFireTriggers(boolean firetriggers) -
isFireTriggers
public boolean isFireTriggers() -
setCheckConstraints
public void setCheckConstraints(boolean checkconstraints) -
isCheckConstraints
public boolean isCheckConstraints() -
setKeepNulls
public void setKeepNulls(boolean keepnulls) -
isKeepNulls
public boolean isKeepNulls() -
setKeepIdentity
public void setKeepIdentity(boolean keepidentity) -
isKeepIdentity
public boolean isKeepIdentity() -
setTablock
public void setTablock(boolean tablock) -
isTablock
public boolean isTablock() -
getResourceDependencies
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 interfaceJobEntryInterface
- Overrides:
getResourceDependencies
in classJobEntryBase
- 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 interfaceJobEntryInterface
- Overrides:
check
in classJobEntryBase
- Parameters:
remarks
- List of CheckResult objects indicating consistency statusjobMeta
- the metadata object for the job entryspace
- the variable space to resolve string expressions with variables withrepository
- the repository to load Kettle objects frommetaStore
- the MetaStore to load common elements from
-