nifi-sqllookup-services-bundle icon indicating copy to clipboard operation
nifi-sqllookup-services-bundle copied to clipboard

NIFI controllers for SQL record and attributes lookups with built-in caching

Apache NiFi SQL Lookup Service

Build Status

  • Apache NiFi SQL Lookup Service
    • About
    • Simple Setup
    • SQL Query Support
    • Caching
      • Supported caches
    • Latest release
    • Articles on using NiFi lookup services

About

NiFI SQL Lookup Service is a SQL-based lookup service for Apache NiFi. It allows you to enrich your flowfiles with any jdbc-compliant data store, including:

  • PostgreSQL
  • Oracle
  • MySQL
  • MS SQL Server
  • SQLite
  • ... and many more

It includes both LookupRecord and LookupAttribute controllers.

These controllers were designed to be flexible and fast.

Simple Setup

> cd nifi-sqllookup-bundle
> mvn package
> cp ./nifi-sqllookup-services-nar/target/nifi-sqllookup-services-nar-1.15.0.nar /NIFI_INSTALL/lib/
> cp ./nifi-sqllookup-services-api-nar/target/nifi-sqllookup-services-api-nar-1.15.0.nar /NIFI_INSTALL/lib/
  • Start NiFi

SQL Query Support

This service supports multiple query types:

  • Named Parameters: SELECT name FROM foo WHERE value = :value
  • SQL IN queries: SELECT name FROM foo WHERE value IN(:values)
  • Multiple lookup values: SELECT name FROM foo WHERE value IN(:values) AND sequence = :sequence AND catalog = :catalog

Caching

The goal of this service is to return values quickly. It has a built-in cache so that your database doesn't get overwhelmed.

This is configurable in the controller settings.

Supported caches

These caches are all built-in to this service. Select your preferable cache in the controller settings.

You can also select the number of items that you want to cache. The caches all keep the most accessed items available by default.

If you don't know which to choose, just go with the default.

Latest release

https://github.com/mrcsparker/nifi-sqllookup-services-bundle/releases/latest

Articles on using NiFi lookup services