Package org.apache.nifi.lookup.db

Class DatabaseRecordLookupService

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.controller.AbstractControllerService

org.apache.nifi.lookup.db.AbstractDatabaseLookupService

org.apache.nifi.lookup.db.DatabaseRecordLookupService

All Implemented Interfaces:

org.apache.nifi.components.ConfigurableComponent, org.apache.nifi.controller.ControllerService, LookupService<Record>, RecordLookupService

@Tags({"lookup","cache","enrich","join","rdbms","database","reloadable","key","value","record"})
@CapabilityDescription("A relational-database-based lookup service. When the lookup key is found in the database, the specified columns (or all if Lookup Value Columns are not specified) are returned as a Record. Only one row will be returned for each lookup, duplicate database entries are ignored.")
public class DatabaseRecordLookupService
extends AbstractDatabaseLookupService
implements RecordLookupService

Field Summary

Fields

Modifier and Type	Field	Description
private com.github.benmanes.caffeine.cache.Cache<Tuple<String,Object>,Record>	cache
(package private) static final org.apache.nifi.components.PropertyDescriptor	LOOKUP_VALUE_COLUMNS
private static final List<org.apache.nifi.components.PropertyDescriptor>	PROPERTY_DESCRIPTORS

Fields inherited from class org.apache.nifi.lookup.db.AbstractDatabaseLookupService

CACHE_EXPIRATION, CACHE_SIZE, CLEAR_CACHE_ON_ENABLED, DBCP_SERVICE, dbcpService, KEY, LOOKUP_KEY_COLUMN, lookupKeyColumn, properties, REQUIRED_KEYS, TABLE_NAME

Constructor Summary

Constructors

Constructor	Description
DatabaseRecordLookupService()

Method Summary

Modifier and Type	Method	Description
Set<String>	getRequiredKeys()
protected void	init(org.apache.nifi.controller.ControllerServiceInitializationContext context)
private static boolean	isNotBlank(String value)
Optional<Record>	lookup(Map<String,Object> coordinates)
Optional<Record>	lookup(Map<String,Object> coordinates, Map<String,String> context)
void	onEnabled(org.apache.nifi.controller.ConfigurationContext context)

Methods inherited from class org.apache.nifi.lookup.db.AbstractDatabaseLookupService

getSupportedPropertyDescriptors

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.components.ConfigurableComponent

getIdentifier, getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

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

initialize, isStateful, migrateProperties

Methods inherited from interface org.apache.nifi.lookup.RecordLookupService

getValueType

Field Details

cache

private volatile com.github.benmanes.caffeine.cache.Cache<Tuple<String,Object>,Record> cache

LOOKUP_VALUE_COLUMNS

static final org.apache.nifi.components.PropertyDescriptor LOOKUP_VALUE_COLUMNS

PROPERTY_DESCRIPTORS

private static final List<org.apache.nifi.components.PropertyDescriptor> PROPERTY_DESCRIPTORS

Constructor Details

DatabaseRecordLookupService

public DatabaseRecordLookupService()

Method Details

init

protected void init(org.apache.nifi.controller.ControllerServiceInitializationContext context)

Overrides:

init in class org.apache.nifi.controller.AbstractControllerService

onEnabled

@OnEnabled
public void onEnabled(org.apache.nifi.controller.ConfigurationContext context)

lookup

public Optional<Record> lookup(Map<String,Object> coordinates)
                        throws LookupFailureException

Specified by:

lookup in interface LookupService<Record>

Throws:

LookupFailureException

lookup

public Optional<Record> lookup(Map<String,Object> coordinates,
 Map<String,String> context)
                        throws LookupFailureException

Specified by:

lookup in interface LookupService<Record>

Throws:

LookupFailureException

isNotBlank

private static boolean isNotBlank(String value)

getRequiredKeys

public Set<String> getRequiredKeys()

Specified by:

getRequiredKeys in interface LookupService<Record>