Class RunRecordScriptLoadStep

java.lang.Object

com.kingsrook.qqq.backend.core.processes.implementations.etl.streamedwithfrontend.AbstractLoadStep

com.kingsrook.qqq.backend.core.processes.implementations.scripts.RunRecordScriptLoadStep

All Implemented Interfaces:

ProcessSummaryProviderInterface

public class RunRecordScriptLoadStep
extends AbstractLoadStep
implements ProcessSummaryProviderInterface

Load step for the runRecordScript process - runs the script on a page of records

Field Summary

Fields inherited from class com.kingsrook.qqq.backend.core.processes.implementations.etl.streamedwithfrontend.AbstractLoadStep

session

Constructor Summary

Constructors

Constructor	Description
RunRecordScriptLoadStep()

Method Summary

Modifier and Type	Method	Description
Integer	getOverrideRecordPipeCapacity(RunBackendStepInput runBackendStepInput)	Allow this load step to specify the capacity of the pipe being used by the process.
ArrayList<ProcessSummaryLineInterface>	getProcessSummary(RunBackendStepOutput runBackendStepOutput, boolean isForResultScreen)	Note - object needs to be serializable, and List isn't... so, use ArrayList?
void	runOnePage(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput)	Do the load logic for one page of records

Methods inherited from class com.kingsrook.qqq.backend.core.processes.implementations.etl.streamedwithfrontend.AbstractLoadStep

getTransaction, getTransformStep, openTransaction, postRun, preRun, setTransaction, setTransformStep, withTransformStep

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.kingsrook.qqq.backend.core.processes.implementations.etl.streamedwithfrontend.ProcessSummaryProviderInterface

doGetProcessSummary

Constructor Details

RunRecordScriptLoadStep

public RunRecordScriptLoadStep()

Method Details

getOverrideRecordPipeCapacity

public Integer getOverrideRecordPipeCapacity(RunBackendStepInput runBackendStepInput)

Description copied from class: AbstractLoadStep

Allow this load step to specify the capacity of the pipe being used by the process. The specific use-case for which this is being added is, in the case of a process with many records being extracted, if the load job is too slow, then the pipe can get filled, and the extractor (who puts records into the pipe) can time out waiting for capacity in the pipe to open up, while a slow loader is consuming the records. In other words, for a slow loader, setting a lower pipe capacity can help prevent time-out errors ("Giving up adding record to pipe...")

Overrides:

getOverrideRecordPipeCapacity in class AbstractLoadStep

runOnePage

public void runOnePage(RunBackendStepInput runBackendStepInput,
 RunBackendStepOutput runBackendStepOutput)
                throws QException

Description copied from class: AbstractLoadStep

Do the load logic for one page of records

Specified by:

runOnePage in class AbstractLoadStep

Throws:

QException

getProcessSummary

public ArrayList<ProcessSummaryLineInterface> getProcessSummary(RunBackendStepOutput runBackendStepOutput,
 boolean isForResultScreen)

Description copied from interface: ProcessSummaryProviderInterface

Note - object needs to be serializable, and List isn't... so, use ArrayList?

Specified by:

getProcessSummary in interface ProcessSummaryProviderInterface