Supports Expression Language: true (will be evaluated using Environment variables only)Collection | Collection | | | The Solr collection name, only used with a Solr Type of Cloud Supports Expression Language: true (will be evaluated using flow file attributes and Environment variables) |
Return Type | return_type | XML | | Output format of Solr results. Write Solr documents to FlowFiles as XML or using a Record Writer |
Record Writer | Record Writer | | Controller Service API: RecordSetWriterFactory Implementations: FreeFormTextRecordSetWriter ParquetRecordSetWriter AvroRecordSetWriter JsonRecordSetWriter ScriptedRecordSetWriter XMLRecordSetWriter CSVRecordSetWriter RecordSetWriterLookup | The Record Writer to use in order to write Solr documents to FlowFiles. Must be set if "Records" is used as return type. Supports Expression Language: true (will be evaluated using flow file attributes and Environment variables) |
Solr Query | solr_param_query | *:* | | Solr Query, e. g. field:value Supports Expression Language: true (will be evaluated using flow file attributes and Environment variables) |
Request Handler | solr_param_request_handler | /select | | Define a request handler here, e. g. /query Supports Expression Language: true (will be evaluated using flow file attributes and Environment variables) |
Field List | solr_param_field_list | | | Comma separated list of fields to be included into results, e. g. field1,field2 Supports Expression Language: true (will be evaluated using flow file attributes and Environment variables) |
Sorting of result list | solr_param_sort | | | Comma separated sort clauses to define the sorting of results, e. g. field1 asc, field2 desc Supports Expression Language: true (will be evaluated using flow file attributes and Environment variables) |
Start of results | solr_param_start | | | Offset of result set Supports Expression Language: true (will be evaluated using flow file attributes and Environment variables) |
Rows | solr_param_rows | | | Number of results to be returned for a single request Supports Expression Language: true (will be evaluated using flow file attributes and Environment variables) |
Total amount of returned results | amount_documents_to_return | Only top results | - Entire results
- Only top results
| Total amount of Solr documents to be returned. If this property is set to "Only top results", only single requests will be sent to Solr and the results will be written into single FlowFiles. If it is set to "Entire results", all results matching to the query are retrieved via multiple Solr requests and returned in multiple FlowFiles. For both options, the number of Solr documents to be returned in a FlowFile depends on the configuration of the "Rows" property |
Kerberos User Service | kerberos-user-service | | Controller Service API: KerberosUserService Implementations: KerberosTicketCacheUserService KerberosKeytabUserService KerberosPasswordUserService | Specifies the Kerberos User Controller Service that should be used for authenticating with Kerberos |
Basic Auth Username | Username | | | The username to use when Solr is configured with basic authentication. Supports Expression Language: true (will be evaluated using Environment variables only) |
Basic Auth Password | Password | | | The password to use when Solr is configured with basic authentication. Sensitive Property: true Supports Expression Language: true (will be evaluated using Environment variables only)
This Property is only considered if the [Basic Auth Username] Property has a value specified. |
SSL Context Service | SSL Context Service | | Controller Service API: SSLContextService Implementations: StandardRestrictedSSLContextService StandardSSLContextService | The Controller Service to use in order to obtain an SSL Context. This property must be set when communicating with a Solr over https. |
Solr Socket Timeout | Solr Socket Timeout | 10 seconds | | The amount of time to wait for data on a socket connection to Solr. A value of 0 indicates an infinite timeout. |
Solr Connection Timeout | Solr Connection Timeout | 10 seconds | | The amount of time to wait when establishing a connection to Solr. A value of 0 indicates an infinite timeout. |
Solr Maximum Connections Per Host | Solr Maximum Connections Per Host | 5 | | The maximum number of connections allowed from the Solr client to a single Solr host. |
Dynamic Properties:
Supports Sensitive Dynamic Properties: No
Dynamic Properties allow the user to specify both the name and value of a property.
Name | Value | Description |
---|
A Solr request parameter name | A Solr request parameter value | These parameters will be passed to Solr on the request Supports Expression Language: false |
Relationships:
Name | Description |
---|
stats | Stats about Solr index |
results | Results of Solr queries |
facets | Results of faceted search |
failure | Failure relationship |
original | Original flowfile |
Reads Attributes:
None specified.Writes Attributes:
Name | Description |
---|
solr.connect | Solr connect string |
solr.collection | Solr collection |
solr.query | Query string sent to Solr |
solr.cursor.mark | Cursor mark can be used for scrolling Solr |
solr.status.code | Status code of Solr request. A status code of 0 indicates that the request was successfully processed |
solr.query.time | The elapsed time to process the query (in ms) |
solr.start | Solr start parameter (result offset) for the query |
solr.rows | Number of Solr documents to be returned for the query |
solr.number.results | Number of Solr documents that match the query |
mime.type | The mime type of the data format |
querysolr.exeption.class | The Java exception class raised when the processor fails |
querysolr.exeption.message | The Java exception message raised when the processor fails |
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.