GetSolr

Description:

Queries Solr and outputs the results as a FlowFile

Tags:

Apache, Solr, Get, Pull

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, whether a property supports the NiFi Expression Language, and whether a property is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the nifi.properties file has an entry for the property nifi.sensitive.props.key.

NameDefault ValueAllowable ValuesDescription
Solr TypeStandard
  • Cloud A SolrCloud instance.
  • Standard A stand-alone Solr instance.
The type of Solr instance, Cloud or Standard.
Solr LocationThe Solr url for a Solr Type of Standard (ex: http://localhost:8984/solr/gettingstarted), or the ZooKeeper hosts for a Solr Type of Cloud (ex: localhost:9983).
Supports Expression Language: true
CollectionThe Solr collection name, only used with a Solr Type of Cloud
Supports Expression Language: true
Solr QueryA query to execute against Solr
Return FieldsComma-separated list of fields names to return
Sort ClauseA Solr sort clause, ex: field1 asc, field2 desc
Date FieldThe name of a date field in Solr used to filter results
Batch Size100Number of rows per Solr query
JAAS Client App NameThe name of the JAAS configuration entry to use when performing Kerberos authentication to Solr. If this property is not provided, Kerberos authentication will not be attempted. The value must match an entry in the file specified by the system property java.security.auth.login.config.
UsernameThe username to use when Solr is configured with basic authentication.
Supports Expression Language: true
PasswordThe password to use when Solr is configured with basic authentication.
Sensitive Property: true
Supports Expression Language: true
SSL Context ServiceController Service API:
SSLContextService
Implementation: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 Timeout10 secondsThe amount of time to wait for data on a socket connection to Solr. A value of 0 indicates an infinite timeout.
Solr Connection Timeout10 secondsThe amount of time to wait when establishing a connection to Solr. A value of 0 indicates an infinite timeout.
Solr Maximum Connections10The maximum number of total connections allowed from the Solr client to Solr.
Solr Maximum Connections Per Host5The maximum number of connections allowed from the Solr client to a single Solr host.
ZooKeeper Client Timeout10 secondsThe amount of time to wait for data on a connection to ZooKeeper, only used with a Solr Type of Cloud.
ZooKeeper Connection Timeout10 secondsThe amount of time to wait when establishing a connection to ZooKeeper, only used with a Solr Type of Cloud.

Relationships:

NameDescription
successThe results of querying Solr

Reads Attributes:

None specified.

Writes Attributes:

None specified.

State management:

This component does not store state.

Restricted:

This component is not restricted.

Input requirement:

This component does not allow an incoming relationship.