GetMongoRecord
Description
A record-based version of GetMongo that uses the Record writers to write the MongoDB result set.
Tags
fetch, get, json, mongo, mongodb, record
Properties
In the list below required Properties are shown with an asterisk (*). Other properties 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: MongoDBClientService Implementations: MongoDBControllerService | If configured, this property will use the assigned client service for connection pooling. | |
| Record Writer * | get-mongo-record-writer-factory | Controller Service: RecordSetWriterFactory Implementations: AvroRecordSetWriter CSVRecordSetWriter FreeFormTextRecordSetWriter JsonRecordSetWriter RecordSetWriterLookup ScriptedRecordSetWriter XMLRecordSetWriter | The record writer to use to write the result sets. | |
| Mongo Database Name * | Mongo Database Name | The name of the database to use Supports Expression Language, using FlowFile attributes and Environment variables. | ||
| Mongo Collection Name * | Mongo Collection Name | The name of the collection to use Supports Expression Language, using FlowFile attributes and Environment variables. | ||
| Schema Name * | mongodb-schema-name | ${schema.name} | The name of the schema in the configured schema registry to use for the query results. Supports Expression Language, using FlowFile attributes and Environment variables. | |
| Query Output Attribute | mongo-query-attribute | If set, the query will be written to a specified attribute on the output flowfiles. Supports Expression Language, using FlowFile attributes and Environment variables. | ||
| 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, using FlowFile attributes and Environment variables. | ||
| Projection | Projection | The fields to be returned from the documents in the result set; must be a valid BSON document Supports Expression Language, using FlowFile attributes and Environment variables. | ||
| Sort | Sort | The fields by which to sort; must be a valid BSON document Supports Expression Language, using FlowFile attributes and Environment variables. | ||
| Limit | Limit | The maximum number of elements to return Supports Expression Language, using FlowFile attributes and Environment variables. | ||
| Batch Size | Batch Size | The number of elements to be returned from the server in one batch Supports Expression Language, using FlowFile attributes and Environment variables. |
Dynamic Properties
This component does not support dynamic properties.
Relationships
| Name | Description |
|---|---|
| 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. |
| success | All FlowFiles that have the results of a successful query execution go here. |
Reads Attributes
This processor does not read attributes.
Writes Attributes
| Name | Description |
|---|---|
| mongo.collection.name | The collection where the results came from. |
| mongo.database.name | The database 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
This component does not specify system resource considerations.