org.apache.nifi.processors.hive

Class PutHiveQL

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.hive.AbstractHiveQLProcessor

org.apache.nifi.processors.hive.PutHiveQL

All Implemented Interfaces:

ConfigurableComponent, Processor

@SeeAlso(value=SelectHiveQL.class)
 @InputRequirement(value=INPUT_REQUIRED)
 @Tags(value={"sql","hive","put","database","update","insert"})
 @CapabilityDescription(value="Executes a HiveQL DDL/DML command (UPDATE, INSERT, e.g.). The content of an incoming FlowFile is expected to be the HiveQL command to execute. The HiveQL command may use the ? to escape parameters. In this case, the parameters to use must exist as FlowFile attributes with the naming convention hiveql.args.N.type and hiveql.args.N.value, where N is a positive integer. The hiveql.args.N.type is expected to be a number indicating the JDBC Type. The content of the FlowFile is expected to be in UTF-8 format.")
 @ReadsAttribute(attribute="hiveql.args.N.type",description="Incoming FlowFiles are expected to be parametrized HiveQL statements. The type of each Parameter is specified as an integer that represents the JDBC Type of the parameter.") @ReadsAttribute(attribute="hiveql.args.N.value",description="Incoming FlowFiles are expected to be parametrized HiveQL statements. The value of the Parameters are specified as hiveql.args.1.value, hiveql.args.2.value, hiveql.args.3.value, and so on. The type of the hiveql.args.1.value Parameter is specified by the hiveql.args.1.type attribute.")
public class PutHiveQL
extends AbstractHiveQLProcessor

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyDescriptor	BATCH_SIZE
static PropertyDescriptor	CHARSET
private static Pattern	HIVEQL_TYPE_ATTRIBUTE_PATTERN
private static Pattern	NUMBER_PATTERN
private static List<PropertyDescriptor>	propertyDescriptors
static Relationship	REL_FAILURE
static Relationship	REL_RETRY
static Relationship	REL_SUCCESS
private static Set<Relationship>	relationships

Fields inherited from class org.apache.nifi.processors.hive.AbstractHiveQLProcessor

HIVE_DBCP_SERVICE

Constructor Summary

Constructors

Constructor and Description
PutHiveQL()

Method Summary

Modifier and Type	Method and Description
private String	getHiveQL(ProcessSession session, FlowFile flowFile, Charset charset) Determines the HiveQL statement that should be executed for the given FlowFile
Set<Relationship>	getRelationships()
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
void	onTrigger(ProcessContext context, ProcessSession session)
private void	setParameter(PreparedStatement stmt, String attrName, int parameterIndex, String parameterValue, int jdbcType) Determines how to map the given value to the appropriate JDBC data type and sets the parameter on the provided PreparedStatement
private void	setParameters(PreparedStatement stmt, Map<String,String> attributes) Sets all of the appropriate parameters on the given PreparedStatement, based on the given FlowFile attributes.

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

BATCH_SIZE

public static final PropertyDescriptor BATCH_SIZE

CHARSET

public static final PropertyDescriptor CHARSET

REL_SUCCESS

public static final Relationship REL_SUCCESS

REL_RETRY

public static final Relationship REL_RETRY

REL_FAILURE

public static final Relationship REL_FAILURE

HIVEQL_TYPE_ATTRIBUTE_PATTERN

private static final Pattern HIVEQL_TYPE_ATTRIBUTE_PATTERN

NUMBER_PATTERN

private static final Pattern NUMBER_PATTERN

propertyDescriptors

private static final List<PropertyDescriptor> propertyDescriptors

relationships

private static final Set<Relationship> relationships

Constructor Detail

PutHiveQL

public PutHiveQL()

Method Detail

getSupportedPropertyDescriptors

protected List<PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

getRelationships

public Set<Relationship> getRelationships()

Specified by:

getRelationships in interface Processor

Overrides:

getRelationships in class AbstractSessionFactoryProcessor

onTrigger

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

Specified by:

onTrigger in class AbstractProcessor

Throws:

ProcessException

getHiveQL

private String getHiveQL(ProcessSession session,
                         FlowFile flowFile,
                         Charset charset)

Determines the HiveQL statement that should be executed for the given FlowFile

Parameters:

session - the session that can be used to access the given FlowFile

flowFile - the FlowFile whose HiveQL statement should be executed

Returns:

the HiveQL that is associated with the given FlowFile

setParameters

private void setParameters(PreparedStatement stmt,
                           Map<String,String> attributes)
                    throws SQLException

Sets all of the appropriate parameters on the given PreparedStatement, based on the given FlowFile attributes.

Parameters:

stmt - the statement to set the parameters on

attributes - the attributes from which to derive parameter indices, values, and types

Throws:

SQLException - if the PreparedStatement throws a SQLException when the appropriate setter is called

setParameter

private void setParameter(PreparedStatement stmt,
                          String attrName,
                          int parameterIndex,
                          String parameterValue,
                          int jdbcType)
                   throws SQLException

Determines how to map the given value to the appropriate JDBC data type and sets the parameter on the provided PreparedStatement

Parameters:

stmt - the PreparedStatement to set the parameter on

attrName - the name of the attribute that the parameter is coming from - for logging purposes

parameterIndex - the index of the HiveQL parameter to set

parameterValue - the value of the HiveQL parameter to set

jdbcType - the JDBC Type of the HiveQL parameter to set

Throws:

SQLException - if the PreparedStatement throws a SQLException when calling the appropriate setter