MongoDBLookupService

Description:

Provides a lookup service based around MongoDB. Each key that is specified will be added to a query as-is. For example, if you specify the two keys, user and email, the resulting query will be { "user": "tester", "email": "tester@test.com" }. The query is limited to the first result (findOne in the Mongo documentation). If no "Lookup Value Field" is specified then the entire MongoDB result document minus the _id field will be returned as a record.

Tags:

mongo, mongodb, lookup, 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 Name	API Name	Default Value	Allowable Values	Description
Schema Access Strategy	schema-access-strategy	Infer from Result	Use 'Schema Name' Property Use 'Schema Text' Property Infer from Result	Specifies how to obtain the schema that is to be used for interpreting the data.
Schema Registry	schema-registry		Controller Service API: SchemaRegistry Implementations: DatabaseTableSchemaRegistry HortonworksSchemaRegistry ConfluentSchemaRegistry AvroSchemaRegistry AmazonGlueSchemaRegistry	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: [Use 'Schema Name' Property]
Schema Name	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 variable registry only) This Property is only considered if the [Schema Access Strategy] Property has a value of "Use 'Schema Name' Property".
Schema Version	schema-version			Specifies 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 "Use 'Schema Name' Property".
Schema Branch	schema-branch			Specifies 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 "Use 'Schema Name' Property".
Schema Text	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 "Use 'Schema Text' Property".
Client Service	mongo-lookup-client-service		Controller Service API: MongoDBClientService Implementation: MongoDBControllerService	A MongoDB controller service to use with this lookup service.
Mongo Database Name	mongo-db-name			The name of the database to use Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Mongo Collection Name	mongo-collection-name			The name of the collection to use Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Lookup Value Field	mongo-lookup-value-field			The field whose value will be returned when the lookup key(s) match a record. If not specified then the entire MongoDB result document minus the _id field will be returned as a record.
Projection	mongo-lookup-projection			Specifies a projection for limiting which fields will be returned.

State management:

This component does not store state.

Restricted:

This component is not restricted.

System Resource Considerations:

None specified.