org.apache.nifi.hbase

Class PutHBaseRecord

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.hbase.AbstractPutHBase

org.apache.nifi.hbase.PutHBaseRecord

All Implemented Interfaces:

ConfigurableComponent, Processor

@EventDriven
 @SupportsBatching
 @InputRequirement(value=INPUT_REQUIRED)
 @Tags(value={"hadoop","hbase","put","record"})
 @CapabilityDescription(value="Adds rows to HBase based on the contents of a flowfile using a configured record reader.")
 @ReadsAttribute(attribute="restart.index",
                description="Reads restart.index when it needs to replay part of a record set that did not get into HBase.")
 @WritesAttribute(attribute="restart.index",
                 description="Writes restart.index when a batch fails to be insert into HBase")
public class PutHBaseRecord
extends AbstractPutHBase

Field Summary

Fields

Modifier and Type	Field and Description
protected static PropertyDescriptor	BATCH_SIZE
protected static AllowableValue	COMPLEX_FIELD_FAIL
protected static AllowableValue	COMPLEX_FIELD_IGNORE
protected static PropertyDescriptor	COMPLEX_FIELD_STRATEGY
protected static AllowableValue	COMPLEX_FIELD_TEXT
protected static AllowableValue	COMPLEX_FIELD_WARN
protected static java.lang.String	FAIL_VALUE
protected static AllowableValue	FIELD_ENCODING_BYTES
protected static PropertyDescriptor	FIELD_ENCODING_STRATEGY
protected static AllowableValue	FIELD_ENCODING_STRING
protected static java.lang.String	IGNORE_VALUE
protected static PropertyDescriptor	ROW_FIELD_NAME
protected static java.lang.String	TEXT_VALUE
protected static PropertyDescriptor	TIMESTAMP_FIELD_NAME
protected static java.lang.String	WARN_VALUE

Fields inherited from class org.apache.nifi.hbase.AbstractPutHBase

clientService, COLUMN_FAMILY, COLUMN_QUALIFIER, HBASE_CLIENT_SERVICE, REL_FAILURE, REL_SUCCESS, ROW_ID, ROW_ID_ENCODING_BINARY, ROW_ID_ENCODING_STRING, TABLE_NAME, TIMESTAMP

Constructor Summary

Constructors

Constructor and Description
PutHBaseRecord()

Method Summary

Modifier and Type	Method and Description
protected byte[]	asBytes(java.lang.String field, RecordFieldType fieldType, Record record, boolean asString, java.lang.String complexFieldStrategy)
protected PutFlowFile	createPut(ProcessContext context, Record record, RecordSchema schema, FlowFile flowFile, java.lang.String rowFieldName, java.lang.String columnFamily, java.lang.String timestampFieldName, java.lang.String fieldEncodingStrategy, java.lang.String rowEncodingStrategy, java.lang.String complexFieldStrategy)
protected PutFlowFile	createPut(ProcessSession session, ProcessContext context, FlowFile flowFile) Sub-classes provide the implementation to create a put from a FlowFile.
java.util.Set<Relationship>	getRelationships()
java.util.List<PropertyDescriptor>	getSupportedPropertyDescriptors() Allows subclasses to register which property descriptor objects are supported.
protected java.lang.String	getTransitUri(PutFlowFile putFlowFile)
void	onTrigger(ProcessContext context, ProcessSession session)

Methods inherited from class org.apache.nifi.hbase.AbstractPutHBase

getRow, onScheduled

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

ROW_FIELD_NAME

protected static final PropertyDescriptor ROW_FIELD_NAME

TIMESTAMP_FIELD_NAME

protected static final PropertyDescriptor TIMESTAMP_FIELD_NAME

FAIL_VALUE

protected static final java.lang.String FAIL_VALUE

See Also:

Constant Field Values

WARN_VALUE

protected static final java.lang.String WARN_VALUE

See Also:

Constant Field Values

IGNORE_VALUE

protected static final java.lang.String IGNORE_VALUE

See Also:

Constant Field Values

TEXT_VALUE

protected static final java.lang.String TEXT_VALUE

See Also:

Constant Field Values

COMPLEX_FIELD_FAIL

protected static final AllowableValue COMPLEX_FIELD_FAIL

COMPLEX_FIELD_WARN

protected static final AllowableValue COMPLEX_FIELD_WARN

COMPLEX_FIELD_IGNORE

protected static final AllowableValue COMPLEX_FIELD_IGNORE

COMPLEX_FIELD_TEXT

protected static final AllowableValue COMPLEX_FIELD_TEXT

COMPLEX_FIELD_STRATEGY

protected static final PropertyDescriptor COMPLEX_FIELD_STRATEGY

FIELD_ENCODING_STRING

protected static final AllowableValue FIELD_ENCODING_STRING

FIELD_ENCODING_BYTES

protected static final AllowableValue FIELD_ENCODING_BYTES

FIELD_ENCODING_STRATEGY

protected static final PropertyDescriptor FIELD_ENCODING_STRATEGY

BATCH_SIZE

protected static final PropertyDescriptor BATCH_SIZE

Constructor Detail

PutHBaseRecord

public PutHBaseRecord()

Method Detail

getSupportedPropertyDescriptors

public final java.util.List<PropertyDescriptor> getSupportedPropertyDescriptors()

Description copied from class: AbstractConfigurableComponent

Allows subclasses to register which property descriptor objects are supported. Default return is an empty set.

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

Returns:

PropertyDescriptor objects this processor currently supports

getRelationships

public java.util.Set<Relationship> getRelationships()

Specified by:

getRelationships in interface Processor

Overrides:

getRelationships in class AbstractSessionFactoryProcessor

Returns:

Set of all relationships this processor expects to transfer a flow file to. An empty set indicates this processor does not have any destination relationships. Guaranteed non null.

onTrigger

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

Overrides:

onTrigger in class AbstractPutHBase

Throws:

ProcessException

getTransitUri

protected java.lang.String getTransitUri(PutFlowFile putFlowFile)

Overrides:

getTransitUri in class AbstractPutHBase

createPut

protected PutFlowFile createPut(ProcessSession session,
                                ProcessContext context,
                                FlowFile flowFile)

Description copied from class: AbstractPutHBase

Sub-classes provide the implementation to create a put from a FlowFile.

Specified by:

createPut in class AbstractPutHBase

Parameters:

session - the current session

context - the current context

flowFile - the FlowFile to create a Put from

Returns:

a PutFlowFile instance for the given FlowFile

asBytes

protected byte[] asBytes(java.lang.String field,
                         RecordFieldType fieldType,
                         Record record,
                         boolean asString,
                         java.lang.String complexFieldStrategy)
                  throws org.apache.nifi.hbase.PutHBaseRecord.PutCreationFailedInvokedException

Throws:

org.apache.nifi.hbase.PutHBaseRecord.PutCreationFailedInvokedException

createPut

protected PutFlowFile createPut(ProcessContext context,
                                Record record,
                                RecordSchema schema,
                                FlowFile flowFile,
                                java.lang.String rowFieldName,
                                java.lang.String columnFamily,
                                java.lang.String timestampFieldName,
                                java.lang.String fieldEncodingStrategy,
                                java.lang.String rowEncodingStrategy,
                                java.lang.String complexFieldStrategy)
                         throws org.apache.nifi.hbase.PutHBaseRecord.PutCreationFailedInvokedException

Throws:

org.apache.nifi.hbase.PutHBaseRecord.PutCreationFailedInvokedException