ScanAccumulo

Description:

Scan the given table and writes result in a flowfile. Value will be represented as UTF-8 Encoded String.

Tags:

hadoop, accumulo, scan, record

Properties:

In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.

Display NameAPI NameDefault ValueAllowable ValuesDescription
Accumulo Connector Serviceaccumulo-connector-serviceController Service API:
BaseAccumuloService
Implementation: AccumuloService
Specifies the Controller Service to use for accessing Accumulo.
Table NameTable NameThe name of the Accumulo Table into which data will be placed
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Create TableCreate TableFalse
  • True
  • False
Creates a table if it does not exist. This property will only be used when EL is not present in 'Table Name'
ThreadsThreads10Number of threads used for reading and writing
Accumulo Timeoutaccumulo-timeout30 secMax amount of time to wait for an unresponsive server. Set to 0 sec for no timeout. Entered value less than 1 second may be converted to 0 sec.
Start keystart-keyStart row key
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Start key Inclusivestart-key-inclusiveTrue
  • True
  • False
Determines if the start key is inclusive
End keyend-keyEnd row key for this. If not specified or empty this will be infinite
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Start Column Familycolumn-familyThe column family that is part of the start key. If no column key is defined only this column family will be selected
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
End Column Familycolumn-family-endThe column family to select is part of end key
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
End key Inclusiveend-key-inclusiveFalse
  • True
  • False
Determines if the end key is inclusive
Value Included in Resultaccumulo-value-inclusiveTrue
  • True
  • False
Beside keys and their values, accumulo value field will also be included in the result as UTF-8 Encoded String.
Record Writerrecord-writerController Service API:
RecordSetWriterFactory
Implementations: JsonRecordSetWriter
ParquetRecordSetWriter
CSVRecordSetWriter
ScriptedRecordSetWriter
XMLRecordSetWriter
FreeFormTextRecordSetWriter
AvroRecordSetWriter
RecordSetWriterLookup
Specifies the Controller Service to use for writing out the records
Authorizationsaccumulo-authorizationsThe comma separated list of authorizations to pass to the scanner.
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)

Relationships:

NameDescription
successA FlowFile is routed to this relationship after it has been successfully retrieved from Accumulo
failureA FlowFile is routed to this relationship if it cannot be retrieved fromAccumulo

Reads Attributes:

None specified.

Writes Attributes:

None specified.

State management:

This component does not store state.

Restricted:

This component is not restricted.

Input requirement:

This component allows an incoming relationship.

System Resource Considerations:

None specified.