GetSolr

Description:

Queries Solr and outputs the results as a FlowFile in the format of XML or using a Record Writer

Tags:

Apache, Solr, Get, Pull, Records

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.

Name	Default Value	Allowable Values	Description
Solr Type	Standard	Cloud Standard	The type of Solr instance, Cloud or Standard.
Solr Location			The 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 (will be evaluated using variable registry only)
Collection			The Solr collection name, only used with a Solr Type of Cloud Supports Expression Language: true (will be evaluated using variable registry only)
Return Type	XML	XML Records	Write Solr documents to FlowFiles as XML or using a Record Writer
Record Writer		Controller Service API: RecordSetWriterFactory Implementations: AvroRecordSetWriter ScriptedRecordSetWriter JsonRecordSetWriter ParquetRecordSetWriter RecordSetWriterLookup FreeFormTextRecordSetWriter XMLRecordSetWriter CSVRecordSetWriter	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 variable registry only)
Solr Query			A query to execute against Solr
Date Field			The name of a date field in Solr used to filter results
Initial Date Filter			Date value to filter results. Documents with an earlier date will not be fetched. The format has to correspond to the date pattern of Solr 'YYYY-MM-DDThh:mm:ssZ'
Return Fields			Comma-separated list of field names to return
Batch Size	100		Number of rows per Solr query
Kerberos Credentials Service		Controller Service API: KerberosCredentialsService Implementation: KeytabCredentialsService	Specifies the Kerberos Credentials Controller Service that should be used for authenticating with Kerberos
Kerberos User Service		Controller Service API: KerberosUserService Implementations: KerberosPasswordUserService KerberosTicketCacheUserService KerberosKeytabUserService	Specifies the Kerberos User Controller Service that should be used for authenticating with Kerberos
Kerberos Principal			The principal to use when specifying the principal and password directly in the processor for authenticating to Solr via Kerberos. Supports Expression Language: true (will be evaluated using variable registry only)
Kerberos Password			The password to use when specifying the principal and password directly in the processor for authenticating to Solr via Kerberos. Sensitive Property: true
Basic Auth Username			The username to use when Solr is configured with basic authentication. Supports Expression Language: true (will be evaluated using variable registry only)
Basic Auth Password			The password to use when Solr is configured with basic authentication. Sensitive Property: true Supports Expression Language: true (will be evaluated using variable registry only)
SSL Context Service		Controller Service API: SSLContextService Implementations: StandardSSLContextService StandardRestrictedSSLContextService	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	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	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	10		The maximum number of total connections allowed from the Solr client to Solr.
Solr Maximum Connections Per Host	5		The maximum number of connections allowed from the Solr client to a single Solr host.
ZooKeeper Client Timeout	10 seconds		The amount of time to wait for data on a connection to ZooKeeper, only used with a Solr Type of Cloud.
ZooKeeper Connection Timeout	10 seconds		The amount of time to wait when establishing a connection to ZooKeeper, only used with a Solr Type of Cloud.

Relationships:

Name	Description
success	The results of querying Solr

Reads Attributes:

None specified.

Writes Attributes:

None specified.

State management:

Scope	Description
CLUSTER	Stores latest date of Date Field so that the same data will not be fetched multiple times.

Restricted:

This component is not restricted.

Input requirement:

This component does not allow an incoming relationship.

System Resource Considerations:

None specified.