org.apache.nifi.processors.rethinkdb

Class PutRethinkDB

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.rethinkdb.PutRethinkDB

All Implemented Interfaces:

ConfigurableComponent, Processor

@InputRequirement(value=INPUT_REQUIRED)
 @EventDriven
 @SupportsBatching
 @Tags(value={"rethinkdb","stream","insert","update","write","put"})
 @CapabilityDescription(value="Processor to write the JSON content of a FlowFile to RethinkDB (https://www.rethinkdb.com/). The flow file should contain either JSON Object an array of JSON documents")
 @WritesAttribute(attribute="rethinkdb.error.message",description="RethinkDB error message") @WritesAttribute(attribute="rethinkdb.insert.errors",description="Error count while inserting documents") @WritesAttribute(attribute="rethinkdb.insert.deleted",description="Number of documents deleted") @WritesAttribute(attribute="rethinkdb.insert.generated_keys",description="Keys generated on inserting documents") @WritesAttribute(attribute="rethinkdb.insert.inserted",description="Number of documents inserted") @WritesAttribute(attribute="rethinkdb.insert.replaced",description="Number of documents replaced") @WritesAttribute(attribute="rethinkdb.insert.skipped",description="Number of documents skipped because they already existed") @WritesAttribute(attribute="rethinkdb.insert.unchanged",description="Number of documents unchanged since they already existed") @WritesAttribute(attribute="rethinkdb.insert.first_error",description="First error while inserting documents") @WritesAttribute(attribute="rethinkdb.insert.warnings",description="Warning message in case of large number of ids being returned on insertion")
 @SeeAlso(value={GetRethinkDB.class,DeleteRethinkDB.class})
public class PutRethinkDB
extends AbstractProcessor

Field Summary

Fields

Modifier and Type	Field and Description
protected static PropertyDescriptor	CHARSET
java.lang.String	CONFLICT_OPTION_KEY
protected static PropertyDescriptor	CONFLICT_STRATEGY
static AllowableValue	CONFLICT_STRATEGY_ERROR
static AllowableValue	CONFLICT_STRATEGY_REPLACE
static AllowableValue	CONFLICT_STRATEGY_UPDATE
protected java.lang.String	databaseName
static PropertyDescriptor	DB_HOST
static PropertyDescriptor	DB_NAME
static PropertyDescriptor	DB_PORT
static java.lang.String	DOCUMENT_ID_EMPTY_MESSAGE
protected static PropertyDescriptor	DURABILITY
static AllowableValue	DURABILITY_HARD
static java.lang.String	DURABILITY_OPTION_KEY
static AllowableValue	DURABILITY_SOFT
protected java.lang.String	hostname
protected static PropertyDescriptor	MAX_DOCUMENTS_SIZE
protected long	maxDocumentsSize
protected java.lang.String	password
static PropertyDescriptor	PASSWORD
protected java.lang.Integer	port
static java.lang.String	RESULT_DELETED_KEY
static java.lang.String	RESULT_ERROR_KEY
static java.lang.String	RESULT_FIRST_ERROR_KEY
static java.lang.String	RESULT_GENERATED_KEYS_KEY
static java.lang.String	RESULT_INSERTED_KEY
static java.lang.String	RESULT_REPLACED_KEY
static java.lang.String	RESULT_SKIPPED_KEY
static java.lang.String	RESULT_UNCHANGED_KEY
static java.lang.String	RESULT_WARNINGS_KEY
static PropertyDescriptor	RETHINKDB_DOCUMENT_ID
static java.lang.String	RETHINKDB_ERROR_MESSAGE
static java.lang.String	RETHINKDB_INSERT_RESULT
static java.lang.String	RETHINKDB_INSERT_RESULT_DELETED_KEY
static java.lang.String	RETHINKDB_INSERT_RESULT_ERROR_KEY
static java.lang.String	RETHINKDB_INSERT_RESULT_FIRST_ERROR_KEY
static java.lang.String	RETHINKDB_INSERT_RESULT_GENERATED_KEYS_KEY
static java.lang.String	RETHINKDB_INSERT_RESULT_INSERTED_KEY
static java.lang.String	RETHINKDB_INSERT_RESULT_REPLACED_KEY
static java.lang.String	RETHINKDB_INSERT_RESULT_SKIPPED_KEY
static java.lang.String	RETHINKDB_INSERT_RESULT_UNCHANGED_KEY
static java.lang.String	RETHINKDB_INSERT_RESULT_WARNINGS_KEY
protected com.rethinkdb.net.Connection	rethinkDbConnection
static PropertyDescriptor	TABLE_NAME
protected java.lang.String	tableName
protected java.lang.String	username
static PropertyDescriptor	USERNAME

Constructor Summary

Constructors

Constructor and Description
PutRethinkDB()

Method Summary

Modifier and Type	Method and Description
void	close() Shutdown client connection
protected com.rethinkdb.gen.ast.Table	getRdbTable()
java.util.Set<Relationship>	getRelationships()
protected com.rethinkdb.RethinkDB	getRethinkDB() Helper method to help testability
java.util.List<PropertyDescriptor>	getSupportedPropertyDescriptors() Allows subclasses to register which property descriptor objects are supported.
protected com.rethinkdb.net.Connection	makeConnection()
void	onScheduled(ProcessContext context)
void	onTrigger(ProcessContext context, ProcessSession session)
protected java.util.HashMap<java.lang.String,java.lang.Object>	runInsert(com.rethinkdb.gen.ast.Insert insert)

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

CONFLICT_STRATEGY_UPDATE

public static AllowableValue CONFLICT_STRATEGY_UPDATE

CONFLICT_STRATEGY_REPLACE

public static AllowableValue CONFLICT_STRATEGY_REPLACE

CONFLICT_STRATEGY_ERROR

public static AllowableValue CONFLICT_STRATEGY_ERROR

CONFLICT_STRATEGY

protected static final PropertyDescriptor CONFLICT_STRATEGY

RETHINKDB_INSERT_RESULT

public static final java.lang.String RETHINKDB_INSERT_RESULT

See Also:

Constant Field Values

RETHINKDB_INSERT_RESULT_ERROR_KEY

public static final java.lang.String RETHINKDB_INSERT_RESULT_ERROR_KEY

See Also:

Constant Field Values

RETHINKDB_INSERT_RESULT_DELETED_KEY

public static final java.lang.String RETHINKDB_INSERT_RESULT_DELETED_KEY

See Also:

Constant Field Values

RETHINKDB_INSERT_RESULT_GENERATED_KEYS_KEY

public static final java.lang.String RETHINKDB_INSERT_RESULT_GENERATED_KEYS_KEY

See Also:

Constant Field Values

RETHINKDB_INSERT_RESULT_INSERTED_KEY

public static final java.lang.String RETHINKDB_INSERT_RESULT_INSERTED_KEY

See Also:

Constant Field Values

RETHINKDB_INSERT_RESULT_REPLACED_KEY

public static final java.lang.String RETHINKDB_INSERT_RESULT_REPLACED_KEY

See Also:

Constant Field Values

RETHINKDB_INSERT_RESULT_SKIPPED_KEY

public static final java.lang.String RETHINKDB_INSERT_RESULT_SKIPPED_KEY

See Also:

Constant Field Values

RETHINKDB_INSERT_RESULT_UNCHANGED_KEY

public static final java.lang.String RETHINKDB_INSERT_RESULT_UNCHANGED_KEY

See Also:

Constant Field Values

RETHINKDB_INSERT_RESULT_FIRST_ERROR_KEY

public static final java.lang.String RETHINKDB_INSERT_RESULT_FIRST_ERROR_KEY

See Also:

Constant Field Values

RETHINKDB_INSERT_RESULT_WARNINGS_KEY

public static final java.lang.String RETHINKDB_INSERT_RESULT_WARNINGS_KEY

See Also:

Constant Field Values

CONFLICT_OPTION_KEY

public final java.lang.String CONFLICT_OPTION_KEY

See Also:

Constant Field Values

CHARSET

protected static final PropertyDescriptor CHARSET

DB_NAME

public static final PropertyDescriptor DB_NAME

DB_HOST

public static final PropertyDescriptor DB_HOST

DB_PORT

public static final PropertyDescriptor DB_PORT

USERNAME

public static final PropertyDescriptor USERNAME

PASSWORD

public static final PropertyDescriptor PASSWORD

TABLE_NAME

public static final PropertyDescriptor TABLE_NAME

MAX_DOCUMENTS_SIZE

protected static final PropertyDescriptor MAX_DOCUMENTS_SIZE

RETHINKDB_DOCUMENT_ID

public static final PropertyDescriptor RETHINKDB_DOCUMENT_ID

DURABILITY_SOFT

public static AllowableValue DURABILITY_SOFT

DURABILITY_HARD

public static AllowableValue DURABILITY_HARD

DURABILITY

protected static final PropertyDescriptor DURABILITY

RESULT_ERROR_KEY

public static final java.lang.String RESULT_ERROR_KEY

See Also:

Constant Field Values

RESULT_DELETED_KEY

public static final java.lang.String RESULT_DELETED_KEY

See Also:

Constant Field Values

RESULT_GENERATED_KEYS_KEY

public static final java.lang.String RESULT_GENERATED_KEYS_KEY

See Also:

Constant Field Values

RESULT_INSERTED_KEY

public static final java.lang.String RESULT_INSERTED_KEY

See Also:

Constant Field Values

RESULT_REPLACED_KEY

public static final java.lang.String RESULT_REPLACED_KEY

See Also:

Constant Field Values

RESULT_SKIPPED_KEY

public static final java.lang.String RESULT_SKIPPED_KEY

See Also:

Constant Field Values

RESULT_UNCHANGED_KEY

public static final java.lang.String RESULT_UNCHANGED_KEY

See Also:

Constant Field Values

RESULT_FIRST_ERROR_KEY

public static final java.lang.String RESULT_FIRST_ERROR_KEY

See Also:

Constant Field Values

RESULT_WARNINGS_KEY

public static final java.lang.String RESULT_WARNINGS_KEY

See Also:

Constant Field Values

DURABILITY_OPTION_KEY

public static final java.lang.String DURABILITY_OPTION_KEY

See Also:

Constant Field Values

RETHINKDB_ERROR_MESSAGE

public static final java.lang.String RETHINKDB_ERROR_MESSAGE

See Also:

Constant Field Values

DOCUMENT_ID_EMPTY_MESSAGE

public static final java.lang.String DOCUMENT_ID_EMPTY_MESSAGE

See Also:

Constant Field Values

rethinkDbConnection

protected com.rethinkdb.net.Connection rethinkDbConnection

databaseName

protected java.lang.String databaseName

tableName

protected java.lang.String tableName

username

protected java.lang.String username

password

protected java.lang.String password

hostname

protected java.lang.String hostname

port

protected java.lang.Integer port

maxDocumentsSize

protected long maxDocumentsSize

Constructor Detail

PutRethinkDB

public PutRethinkDB()

Method Detail

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.

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

onScheduled

@OnScheduled
public void onScheduled(ProcessContext context)

onTrigger

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

Specified by:

onTrigger in class AbstractProcessor

Throws:

ProcessException

runInsert

protected java.util.HashMap<java.lang.String,java.lang.Object> runInsert(com.rethinkdb.gen.ast.Insert insert)

close

@OnStopped
public void close()

Shutdown client connection

getRethinkDB

protected com.rethinkdb.RethinkDB getRethinkDB()

Helper method to help testability

Returns:

RethinkDB instance

getRdbTable

protected com.rethinkdb.gen.ast.Table getRdbTable()

Returns:

the rdbTable

makeConnection

protected com.rethinkdb.net.Connection makeConnection()