org.apache.nifi.processors.standard

Class ExecuteSQL

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.standard.ExecuteSQL

All Implemented Interfaces:

ConfigurableComponent, Processor

@EventDriven
 @InputRequirement(value=INPUT_ALLOWED)
 @Tags(value={"sql","select","jdbc","query","database"})
 @CapabilityDescription(value="Execute provided SQL select query. Query result will be converted to Avro format. Streaming is used so arbitrarily large result sets are supported. This processor can be scheduled to run on a timer, or cron expression, using the standard scheduling methods, or it can be triggered by an incoming FlowFile. If it is triggered by an incoming FlowFile, then attributes of that FlowFile will be available when evaluating the select query. FlowFile attribute \'executesql.row.count\' indicates how many rows were selected.")
 @WritesAttribute(attribute="executesql.row.count",
                 description="Contains the number of rows returned in the select query")
public class ExecuteSQL
extends AbstractProcessor

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyDescriptor	DBCP_SERVICE
static PropertyDescriptor	NORMALIZE_NAMES_FOR_AVRO
private List<PropertyDescriptor>	propDescriptors
static PropertyDescriptor	QUERY_TIMEOUT
static Relationship	REL_FAILURE
static Relationship	REL_SUCCESS
private Set<Relationship>	relationships
static String	RESULT_ROW_COUNT
static PropertyDescriptor	SQL_SELECT_QUERY

Constructor Summary

Constructors

Constructor and Description
ExecuteSQL()

Method Summary

Modifier and Type	Method and Description
Set<Relationship>	getRelationships()
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
void	onTrigger(ProcessContext context, ProcessSession session)
void	setup(ProcessContext context)

Methods inherited from class org.apache.nifi.processor.AbstractProcessor

onTrigger

Methods inherited from class org.apache.nifi.processor.AbstractSessionFactoryProcessor

getControllerServiceLookup, getIdentifier, getLogger, getNodeTypeProvider, init, initialize, isConfigurationRestored, isScheduled, toString, updateConfiguredRestoredTrue, updateScheduledFalse, updateScheduledTrue

Methods inherited from class org.apache.nifi.components.AbstractConfigurableComponent

customValidate, equals, getPropertyDescriptor, getPropertyDescriptors, getSupportedDynamicPropertyDescriptor, hashCode, onPropertyModified, validate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.nifi.components.ConfigurableComponent

getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Field Detail

RESULT_ROW_COUNT

public static final String RESULT_ROW_COUNT

See Also:

Constant Field Values

REL_SUCCESS

public static final Relationship REL_SUCCESS

REL_FAILURE

public static final Relationship REL_FAILURE

relationships

private final Set<Relationship> relationships

DBCP_SERVICE

public static final PropertyDescriptor DBCP_SERVICE

SQL_SELECT_QUERY

public static final PropertyDescriptor SQL_SELECT_QUERY

QUERY_TIMEOUT

public static final PropertyDescriptor QUERY_TIMEOUT

NORMALIZE_NAMES_FOR_AVRO

public static final PropertyDescriptor NORMALIZE_NAMES_FOR_AVRO

propDescriptors

private final List<PropertyDescriptor> propDescriptors

Constructor Detail

ExecuteSQL

public ExecuteSQL()

Method Detail

getRelationships

public Set<Relationship> getRelationships()

Specified by:

getRelationships in interface Processor

Overrides:

getRelationships in class AbstractSessionFactoryProcessor

getSupportedPropertyDescriptors

protected List<PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

setup

@OnScheduled
public void setup(ProcessContext context)

onTrigger

public void onTrigger(ProcessContext context,
                      ProcessSession session)
               throws ProcessException

Specified by:

onTrigger in class AbstractProcessor

Throws:

ProcessException