org.apache.nifi.record.sink.db

Class DatabaseRecordSink

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.controller.AbstractControllerService

org.apache.nifi.record.sink.db.DatabaseRecordSink

All Implemented Interfaces:

ConfigurableComponent, ControllerService, RecordSinkService

@Tags(value={"db","jdbc","database","connection","record"})
 @CapabilityDescription(value="Provides a service to write records using a configured database connection.")
public class DatabaseRecordSink
extends AbstractControllerService
implements RecordSinkService

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	DatabaseRecordSink.ColumnDescription
private static class	DatabaseRecordSink.DMLSettings
(package private) static class	DatabaseRecordSink.SqlAndIncludedColumns A holder class for a SQL prepared statement and a BitSet indicating which columns are being inserted (to determine which values from the record to set on the statement) A value of null for getIncludedColumns indicates that all columns/fields should be included.
(package private) static class	DatabaseRecordSink.TableSchema

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static PropertyDescriptor	CATALOG_NAME
private ConfigurationContext	context
(package private) static PropertyDescriptor	DBCP_SERVICE
private DBCPService	dbcpService
(package private) static AllowableValue	FAIL_UNMATCHED_COLUMN
(package private) static AllowableValue	FAIL_UNMATCHED_FIELD
(package private) static AllowableValue	IGNORE_UNMATCHED_COLUMN
(package private) static AllowableValue	IGNORE_UNMATCHED_FIELD
private List<PropertyDescriptor>	properties
(package private) static PropertyDescriptor	QUERY_TIMEOUT
(package private) static PropertyDescriptor	QUOTED_IDENTIFIERS
(package private) static PropertyDescriptor	QUOTED_TABLE_IDENTIFIER
(package private) static PropertyDescriptor	SCHEMA_NAME
(package private) static PropertyDescriptor	TABLE_NAME
(package private) static PropertyDescriptor	TRANSLATE_FIELD_NAMES
(package private) static PropertyDescriptor	UNMATCHED_COLUMN_BEHAVIOR
(package private) static PropertyDescriptor	UNMATCHED_FIELD_BEHAVIOR
(package private) static AllowableValue	WARNING_UNMATCHED_COLUMN

Fields inherited from interface org.apache.nifi.record.sink.RecordSinkService

RECORD_WRITER_FACTORY

Constructor Summary

Constructors

Constructor and Description
DatabaseRecordSink()

Method Summary

Modifier and Type	Method and Description
private DatabaseRecordSink.SqlAndIncludedColumns	generateInsert(RecordSchema recordSchema, String tableName, DatabaseRecordSink.TableSchema tableSchema, DatabaseRecordSink.DMLSettings settings)
private Set<String>	getNormalizedColumnNames(RecordSchema schema, boolean translateFieldNames)
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
protected void	init(ControllerServiceInitializationContext context)
private static String	normalizeColumnName(String colName, boolean translateColumnNames)
void	onEnabled(ConfigurationContext context)
WriteResult	sendData(RecordSet recordSet, Map<String,String> attributes, boolean sendZeroResults)

Methods inherited from class org.apache.nifi.controller.AbstractControllerService

abstractClearConfigContext, abstractStoreConfigContext, disabled, enabled, getConfigurationContext, getControllerServiceLookup, getIdentifier, getLogger, getNodeTypeProvider, getProperty, getStateManager, initialize, isEnabled

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.nifi.record.sink.RecordSinkService

reset

Methods inherited from interface org.apache.nifi.controller.ControllerService

initialize, isStateful

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

getIdentifier, getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Field Detail

IGNORE_UNMATCHED_FIELD

static final AllowableValue IGNORE_UNMATCHED_FIELD

FAIL_UNMATCHED_FIELD

static final AllowableValue FAIL_UNMATCHED_FIELD

IGNORE_UNMATCHED_COLUMN

static final AllowableValue IGNORE_UNMATCHED_COLUMN

WARNING_UNMATCHED_COLUMN

static final AllowableValue WARNING_UNMATCHED_COLUMN

FAIL_UNMATCHED_COLUMN

static final AllowableValue FAIL_UNMATCHED_COLUMN

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

TRANSLATE_FIELD_NAMES

static final PropertyDescriptor TRANSLATE_FIELD_NAMES

UNMATCHED_FIELD_BEHAVIOR

static final PropertyDescriptor UNMATCHED_FIELD_BEHAVIOR

UNMATCHED_COLUMN_BEHAVIOR

static final PropertyDescriptor UNMATCHED_COLUMN_BEHAVIOR

QUOTED_IDENTIFIERS

static final PropertyDescriptor QUOTED_IDENTIFIERS

QUOTED_TABLE_IDENTIFIER

static final PropertyDescriptor QUOTED_TABLE_IDENTIFIER

QUERY_TIMEOUT

static final PropertyDescriptor QUERY_TIMEOUT

properties

private List<PropertyDescriptor> properties

context

private volatile ConfigurationContext context

dbcpService

private volatile DBCPService dbcpService

Constructor Detail

DatabaseRecordSink

public DatabaseRecordSink()

Method Detail

init

protected void init(ControllerServiceInitializationContext context)

Overrides:

init in class AbstractControllerService

getSupportedPropertyDescriptors

protected List<PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

onEnabled

@OnEnabled
public void onEnabled(ConfigurationContext context)

sendData

public WriteResult sendData(RecordSet recordSet,
                            Map<String,String> attributes,
                            boolean sendZeroResults)
                     throws IOException

Specified by:

sendData in interface RecordSinkService

Throws:

IOException

normalizeColumnName

private static String normalizeColumnName(String colName,
                                          boolean translateColumnNames)

getNormalizedColumnNames

private Set<String> getNormalizedColumnNames(RecordSchema schema,
                                             boolean translateFieldNames)

generateInsert

private DatabaseRecordSink.SqlAndIncludedColumns generateInsert(RecordSchema recordSchema,
                                                                String tableName,
                                                                DatabaseRecordSink.TableSchema tableSchema,
                                                                DatabaseRecordSink.DMLSettings settings)
                                                         throws IllegalArgumentException,
                                                                SQLException

Throws:

IllegalArgumentException

SQLException