A record-based version of GetMongo that uses the Record writers to write the MongoDB result set.
mongo, mongodb, get, fetch, record, json
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. | |
| Record Writer | get-mongo-record-writer-factory | Controller Service API: RecordSetWriterFactory Implementations: FreeFormTextRecordSetWriter CSVRecordSetWriter ParquetRecordSetWriter RecordSetWriterLookup ScriptedRecordSetWriter XMLRecordSetWriter JsonRecordSetWriter AvroRecordSetWriter | 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: 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) | ||
| 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: 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) | ||
| 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) | ||
| 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) |
| 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. |
| Name | Description |
|---|---|
| mongo.database.name | The database where the results came from. |
| mongo.collection.name | The collection where the results came from. |