org.apache.nifi.processors.standard

Class UpdateDatabaseTable

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.standard.UpdateDatabaseTable

All Implemented Interfaces:

ConfigurableComponent, Processor

@Tags(value={"metadata","jdbc","database","table","update","alter"})
 @CapabilityDescription(value="This processor uses a JDBC connection and incoming records to generate any database table changes needed to support the incoming records. It expects a \'flat\' record layout, meaning none of the top-level record fields has nested fields that are intended to become columns themselves.")
 @WritesAttribute(attribute="output.table",description="This attribute is written on the flow files routed to the \'success\' and \'failure\' relationships, and contains the target table name.") @WritesAttribute(attribute="output.path",description="This attribute is written on the flow files routed to the \'success\' and \'failure\' relationships, and contains the path on the file system to the table (or partition location if the table is partitioned).") @WritesAttribute(attribute="mime.type",description="Sets the mime.type attribute to the MIME Type specified by the Record Writer, only if a Record Writer is specified and Update Field Names is \'true\'.") @WritesAttribute(attribute="record.count",description="Sets the number of records in the FlowFile, only if a Record Writer is specified and Update Field Names is \'true\'.")
 @InputRequirement(value=INPUT_REQUIRED)
public class UpdateDatabaseTable
extends AbstractProcessor

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	UpdateDatabaseTable.OutputMetadataHolder

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static String	ATTR_OUTPUT_TABLE
(package private) static PropertyDescriptor	CATALOG_NAME
(package private) static AllowableValue	CREATE_IF_NOT_EXISTS
(package private) static PropertyDescriptor	CREATE_TABLE
(package private) static PropertyDescriptor	DB_TYPE
protected static Map<String,DatabaseAdapter>	dbAdapters
(package private) static PropertyDescriptor	DBCP_SERVICE
(package private) static AllowableValue	FAIL_IF_NOT_EXISTS
(package private) static PropertyDescriptor	PRIMARY_KEY_FIELDS
private static List<PropertyDescriptor>	propertyDescriptors
(package private) static PropertyDescriptor	QUERY_TIMEOUT
(package private) static PropertyDescriptor	QUOTE_COLUMN_IDENTIFIERS
(package private) static PropertyDescriptor	QUOTE_TABLE_IDENTIFIER
(package private) static PropertyDescriptor	RECORD_READER
(package private) static PropertyDescriptor	RECORD_WRITER_FACTORY
static Relationship	REL_FAILURE
static Relationship	REL_SUCCESS
protected static Set<Relationship>	relationships
(package private) static PropertyDescriptor	SCHEMA_NAME
(package private) static PropertyDescriptor	TABLE_NAME
(package private) static PropertyDescriptor	TRANSLATE_FIELD_NAMES
(package private) static PropertyDescriptor	UPDATE_FIELD_NAMES

Constructor Summary

Constructors

Constructor and Description
UpdateDatabaseTable()

Method Summary

Modifier and Type	Method and Description
private UpdateDatabaseTable.OutputMetadataHolder	checkAndUpdateTableSchema(Connection conn, DatabaseAdapter databaseAdapter, RecordSchema schema, String catalogName, String schemaName, String tableName, boolean createIfNotExists, boolean translateFieldNames, boolean updateFieldNames, Set<String> primaryKeyColumnNames, boolean quoteTableName, boolean quoteColumnNames)
protected Collection<ValidationResult>	customValidate(ValidationContext validationContext)
private String	getJdbcUrl(Connection connection)
Set<Relationship>	getRelationships()
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
void	onTrigger(ProcessContext context, ProcessSession session)
private WriteResult	updateRecords(RecordSchema inputRecordSchema, UpdateDatabaseTable.OutputMetadataHolder outputMetadataHolder, RecordReader reader, RecordSetWriter writer)

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

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.processor.Processor

isStateful

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

getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Field Detail

CREATE_IF_NOT_EXISTS

static final AllowableValue CREATE_IF_NOT_EXISTS

FAIL_IF_NOT_EXISTS

static final AllowableValue FAIL_IF_NOT_EXISTS

ATTR_OUTPUT_TABLE

static final String ATTR_OUTPUT_TABLE

See Also:

Constant Field Values

RECORD_READER

static final PropertyDescriptor RECORD_READER

DBCP_SERVICE

static final PropertyDescriptor DBCP_SERVICE

CATALOG_NAME

static final PropertyDescriptor CATALOG_NAME

SCHEMA_NAME

static final PropertyDescriptor SCHEMA_NAME

TABLE_NAME

static final PropertyDescriptor TABLE_NAME

CREATE_TABLE

static final PropertyDescriptor CREATE_TABLE

PRIMARY_KEY_FIELDS

static final PropertyDescriptor PRIMARY_KEY_FIELDS

TRANSLATE_FIELD_NAMES

static final PropertyDescriptor TRANSLATE_FIELD_NAMES

UPDATE_FIELD_NAMES

static final PropertyDescriptor UPDATE_FIELD_NAMES

RECORD_WRITER_FACTORY

static final PropertyDescriptor RECORD_WRITER_FACTORY

QUOTE_COLUMN_IDENTIFIERS

static final PropertyDescriptor QUOTE_COLUMN_IDENTIFIERS

QUOTE_TABLE_IDENTIFIER

static final PropertyDescriptor QUOTE_TABLE_IDENTIFIER

QUERY_TIMEOUT

static final PropertyDescriptor QUERY_TIMEOUT

DB_TYPE

static final PropertyDescriptor DB_TYPE

REL_SUCCESS

public static final Relationship REL_SUCCESS

REL_FAILURE

public static final Relationship REL_FAILURE

dbAdapters

protected static final Map<String,DatabaseAdapter> dbAdapters

propertyDescriptors

private static final List<PropertyDescriptor> propertyDescriptors

relationships

protected static Set<Relationship> relationships

Constructor Detail

UpdateDatabaseTable

public UpdateDatabaseTable()

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

customValidate

protected Collection<ValidationResult> customValidate(ValidationContext validationContext)

Overrides:

customValidate in class AbstractConfigurableComponent

onTrigger

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

Specified by:

onTrigger in class AbstractProcessor

Throws:

ProcessException

checkAndUpdateTableSchema

private UpdateDatabaseTable.OutputMetadataHolder checkAndUpdateTableSchema(Connection conn,
                                                                           DatabaseAdapter databaseAdapter,
                                                                           RecordSchema schema,
                                                                           String catalogName,
                                                                           String schemaName,
                                                                           String tableName,
                                                                           boolean createIfNotExists,
                                                                           boolean translateFieldNames,
                                                                           boolean updateFieldNames,
                                                                           Set<String> primaryKeyColumnNames,
                                                                           boolean quoteTableName,
                                                                           boolean quoteColumnNames)
                                                                    throws IOException

Throws:

IOException

updateRecords

private WriteResult updateRecords(RecordSchema inputRecordSchema,
                                  UpdateDatabaseTable.OutputMetadataHolder outputMetadataHolder,
                                  RecordReader reader,
                                  RecordSetWriter writer)
                           throws IOException

Throws:

IOException

getJdbcUrl

private String getJdbcUrl(Connection connection)