GetMongo

Description:

Creates FlowFiles from documents in MongoDB loaded by a user-specified query.

Tags:

mongodb, read, get

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
Client Service	mongo-client-service		Controller Service API: MongoDBClientService Implementation: MongoDBControllerService	If configured, this property will use the assigned client service for connection pooling.
Mongo URI	Mongo URI			MongoURI, typically of the form: mongodb://host1[:port1][,host2[:port2],...] Supports Expression Language: true (will be evaluated using variable registry only)
Mongo Database Name	Mongo Database 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)
SSL Context Service	ssl-context-service		Controller Service API: SSLContextService Implementations: StandardSSLContextService StandardRestrictedSSLContextService	The SSL Context Service used to provide client certificate information for TLS/SSL connections.
Client Auth	ssl-client-auth	REQUIRED	WANT REQUIRED NONE	Client authentication policy when connecting to secure (TLS/SSL) cluster. Possible values are REQUIRED, WANT, NONE. This property is only used when an SSL Context has been defined and enabled.
JSON Type	json-type	Extended JSON	Extended JSON Standard JSON	By default, MongoDB's Java driver returns "extended JSON". Some of the features of this variant of JSON may cause problems for other JSON parsers that expect only standard JSON types and conventions. This configuration setting controls whether to use extended JSON or provide a clean view that conforms to standard JSON.
Pretty Print Results JSON	use-pretty-printing	True	True False	Choose whether or not to pretty print the JSON from the results of the query. Choosing 'True' can greatly increase the space requirements on disk depending on the complexity of the JSON document
Character Set	mongo-charset	UTF-8		Specifies the character set of the document data. Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Query	Query			The selection criteria to do the lookup. If the field is left blank, it will look for input from an incoming connection from another processor to provide the query as a valid JSON document inside of the FlowFile's body. If this field is left blank and a timer is enabled instead of an incoming connection, that will result in a full collection fetch using a "{}" query. Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Query Output Attribute	mongo-query-attribute			If set, the query will be written to a specified attribute on the output flowfiles. Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Projection	Projection			The fields to be returned from the documents in the result set; must be a valid BSON document Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Sort	Sort			The fields by which to sort; must be a valid BSON document Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Limit	Limit			The maximum number of elements to return Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Batch Size	Batch Size			The number of elements to be returned from the server in one batch Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Results Per FlowFile	results-per-flowfile			How many results to put into a FlowFile at once. The whole body will be treated as a JSON array of results. Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Date Format	mongo-date-format	yyyy-MM-dd'T'HH:mm:ss'Z'		The date format string to use for formatting Date fields that are returned from Mongo. It is only applied when the JSON output format is set to Standard JSON. Full documentation for format characters can be found here: https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
SSL Context Service	ssl-context-service		Controller Service API: SSLContextService Implementations: StandardSSLContextService StandardRestrictedSSLContextService	The SSL Context Service used to provide client certificate information for TLS/SSL connections.
Client Auth	ssl-client-auth	REQUIRED	WANT REQUIRED NONE	Client authentication policy when connecting to secure (TLS/SSL) cluster. Possible values are REQUIRED, WANT, NONE. This property is only used when an SSL Context has been defined and enabled.
Send Empty Result	get-mongo-send-empty	false	true false	If a query executes successfully, but returns no results, send an empty JSON document signifying no result.

Relationships:

Name	Description
success	All FlowFiles that have the results of a successful query execution go here.
failure	All input FlowFiles that are part of a failed query execution go here.
original	All input FlowFiles that are part of a successful query execution go here.

Reads Attributes:

None specified.

Writes Attributes:

Name	Description
mongo.database.name	The database where the results came from.
mongo.collection.name	The collection where the results came from.

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.