Class ExtractViaQueryStep

java.lang.Object

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

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

All Implemented Interfaces:

BackendStep

Direct Known Subclasses:

ExtractViaBasepullQueryStep, GarbageCollectorExtractStep, RunRecordScriptExtractStep

public class ExtractViaQueryStep
extends AbstractExtractStep

Generic implementation of an ExtractStep - that runs a Query action for a specified table. If a query is specified from the caller (e.g., using the process Callback mechanism), that will be used. Else a filter (object or json) in StreamedETLWithFrontendProcess.FIELD_DEFAULT_QUERY_FILTER will be checked.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FIELD_SOURCE_TABLE

Constructor Summary

Constructors

Constructor	Description
ExtractViaQueryStep()

Method Summary

Modifier and Type	Method	Description
RecordPipe	createRecordPipe(RunBackendStepInput runBackendStepInput, Integer overrideCapacity)	Create the record pipe to be used for this process step.
protected void	customizeInputPreQuery(QueryInput queryInput)	chance for sub-classes to change things about the query input, if they want.
Integer	doCount(RunBackendStepInput runBackendStepInput)
protected QQueryFilter	getQueryFilter(RunBackendStepInput runBackendStepInput)
void	preRun(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput)	Allow subclasses to do an action before the run begins.
void	run(RunBackendStepInput runBackendStepInput, RunBackendStepOutput runBackendStepOutput)	Execute the backend step - using the request as input, and the result as output.

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

getLimit, getRecordPipe, setLimit, setRecordPipe

Methods inherited from class java.lang.Object

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

Field Details

FIELD_SOURCE_TABLE

public static final String FIELD_SOURCE_TABLE

See Also:

• Constant Field Values

Constructor Details

ExtractViaQueryStep

public ExtractViaQueryStep()

Method Details

preRun

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

Description copied from class: AbstractExtractStep

Allow subclasses to do an action before the run begins.

Overrides:

preRun in class AbstractExtractStep

Throws:

QException

run

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

Execute the backend step - using the request as input, and the result as output.

Throws:

QException

customizeInputPreQuery

protected void customizeInputPreQuery(QueryInput queryInput)

chance for sub-classes to change things about the query input, if they want.

doCount

public Integer doCount(RunBackendStepInput runBackendStepInput)
                throws QException

Overrides:

doCount in class AbstractExtractStep

Throws:

QException

getQueryFilter

protected QQueryFilter getQueryFilter(RunBackendStepInput runBackendStepInput)
                               throws QException

Throws:

QException

createRecordPipe

public RecordPipe createRecordPipe(RunBackendStepInput runBackendStepInput,
 Integer overrideCapacity)

Create the record pipe to be used for this process step.

Overrides:

createRecordPipe in class AbstractExtractStep