ElasticSearchLookupService

Description:

Lookup a record from Elasticsearch Server associated with the specified document ID. The coordinates that are passed to the lookup must contain the key 'id'.

Additional Details...

Tags:

lookup, enrich, record, elasticsearch

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.

NameDefault ValueAllowable ValuesDescription
Schema Access Strategyinfer
  • Use 'Schema Name' Property The name of the Schema to use is specified by the 'Schema Name' Property. The value of this property is used to lookup the Schema in the configured Schema Registry service.
  • Use 'Schema Text' Property The text of the Schema itself is specified by the 'Schema Text' Property. The value of this property must be a valid Avro Schema. If Expression Language is used, the value of the 'Schema Text' property must be valid after substituting the expressions.
  • Infer from Result
Specifies how to obtain the schema that is to be used for interpreting the data.
Schema RegistryController Service API:
SchemaRegistry
Implementations: HortonworksSchemaRegistry
AvroSchemaRegistry
ConfluentSchemaRegistry		Specifies the Controller Service to use for the Schema Registry

This Property is only considered if the <Schema Access Strategy> Property is set to one of the following values: "confluent-encoded", "schema-name", "hwx-schema-ref-attributes", "hwx-content-encoded-schema"
Schema Name${schema.name}Specifies the name of the schema to lookup in the Schema Registry property
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)

This Property is only considered if the <Schema Access Strategy> Property has a value of "schema-name".
Schema VersionSpecifies the version of the schema to lookup in the Schema Registry. If not specified then the latest version of the schema will be retrieved.
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)

This Property is only considered if the <Schema Access Strategy> Property has a value of "schema-name".
Schema BranchSpecifies the name of the branch to use when looking up the schema in the Schema Registry property. If the chosen Schema Registry does not support branching, this value will be ignored.
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)

This Property is only considered if the <Schema Access Strategy> Property has a value of "schema-name".
Schema Text${avro.schema}The text of an Avro-formatted Schema
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)

This Property is only considered if the <Schema Access Strategy> Property has a value of "schema-text-property".
Client ServiceController Service API:
ElasticSearchClientService
Implementation: ElasticSearchClientServiceImpl		An ElasticSearch client service to use for running queries.
IndexThe name of the index to read from
Supports Expression Language: true (will be evaluated using variable registry only)
TypeThe type of this document (used by Elasticsearch for indexing and searching)
Supports Expression Language: true (will be evaluated using variable registry only)

State management:

This component does not store state.

Restricted:

This component is not restricted.

System Resource Considerations:

None specified.