GetSolr

Description:

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

Additional Details...

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, and whether a property supports the NiFi Expression Language.

Display NameAPI NameDefault ValueAllowable ValuesDescription
Solr TypeSolr TypeStandard
  • Cloud A SolrCloud instance.
  • Standard A stand-alone Solr instance.
The type of Solr instance, Cloud or Standard.
Solr LocationSolr 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 (will be evaluated using variable registry only)
CollectionCollectionThe Solr collection name, only used with a Solr Type of Cloud
Supports Expression Language: true (will be evaluated using variable registry only)
Return TypeReturn TypeXML
  • XML
  • Records
Write Solr documents to FlowFiles as XML or using a Record Writer
Record WriterRecord WriterController Service API:
RecordSetWriterFactory
Implementations: RecordSetWriterLookup
XMLRecordSetWriter
FreeFormTextRecordSetWriter
CSVRecordSetWriter
ScriptedRecordSetWriter
AvroRecordSetWriter
JsonRecordSetWriter
ParquetRecordSetWriter
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 QuerySolr QueryA query to execute against Solr
Date FieldDate FieldThe name of a date field in Solr used to filter results
Initial Date FilterInitial Date FilterDate 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 FieldsReturn FieldsComma-separated list of field names to return
Batch SizeBatch Size100Number of rows per Solr query
Kerberos Credentials Servicekerberos-credentials-serviceController Service API:
KerberosCredentialsService
Implementation: KeytabCredentialsService
Specifies the Kerberos Credentials Controller Service that should be used for authenticating with Kerberos
Kerberos User Servicekerberos-user-serviceController Service API:
KerberosUserService
Implementations: KerberosKeytabUserService
KerberosTicketCacheUserService
KerberosPasswordUserService
Specifies the Kerberos User Controller Service that should be used for authenticating with Kerberos
Kerberos Principalkerberos-principalThe 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 Passwordkerberos-passwordThe password to use when specifying the principal and password directly in the processor for authenticating to Solr via Kerberos.
Sensitive Property: true
Basic Auth UsernameUsernameThe username to use when Solr is configured with basic authentication.
Supports Expression Language: true (will be evaluated using variable registry only)
Basic Auth PasswordPasswordThe 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 ServiceSSL Context ServiceController 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 TimeoutSolr 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 TimeoutSolr Connection Timeout10 secondsThe amount of time to wait when establishing a connection to Solr. A value of 0 indicates an infinite timeout.
Solr Maximum ConnectionsSolr Maximum Connections10The maximum number of total connections allowed from the Solr client to Solr.
Solr Maximum Connections Per HostSolr Maximum Connections Per Host5The maximum number of connections allowed from the Solr client to a single Solr host.
ZooKeeper Client TimeoutZooKeeper 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 TimeoutZooKeeper 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:

ScopeDescription
CLUSTERStores 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.