| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>GetSolr</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">GetSolr</h1><h2>Description: </h2><p>Queries Solr and outputs the results as a FlowFile in the format of XML or using a Record Writer</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>Apache, Solr, Get, Pull, Records</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the <a href="../../../../../html/expression-language-guide.html">NiFi Expression Language</a>.</p><table id="properties"><tr><th>Display Name</th><th>API Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Solr Type</strong></td><td>Solr Type</td><td id="default-value">Standard</td><td id="allowable-values"><ul><li>Cloud <img src="../../../../../html/images/iconInfo.png" alt="A SolrCloud instance." title="A SolrCloud instance."></img></li><li>Standard <img src="../../../../../html/images/iconInfo.png" alt="A stand-alone Solr instance." title="A stand-alone Solr instance."></img></li></ul></td><td id="description">The type of Solr instance, Cloud or Standard.</td></tr><tr><td id="name"><strong>Solr Location</strong></td><td>Solr Location</td><td></td><td id="allowable-values"></td><td id="description">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).<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Collection</td><td>Collection</td><td></td><td id="allowable-values"></td><td id="description">The Solr collection name, only used with a Solr Type of Cloud<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Return Type</strong></td><td>Return Type</td><td id="default-value">XML</td><td id="allowable-values"><ul><li>XML</li><li>Records</li></ul></td><td id="description">Write Solr documents to FlowFiles as XML or using a Record Writer</td></tr><tr><td id="name">Record Writer</td><td>Record Writer</td><td></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>RecordSetWriterFactory<br/><strong>Implementations: </strong><a href="../../../nifi-record-serialization-services-nar/1.19.1/org.apache.nifi.text.FreeFormTextRecordSetWriter/index.html">FreeFormTextRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.19.1/org.apache.nifi.avro.AvroRecordSetWriter/index.html">AvroRecordSetWriter</a><br/><a href="../../../nifi-scripting-nar/1.19.1/org.apache.nifi.record.script.ScriptedRecordSetWriter/index.html">ScriptedRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.19.1/org.apache.nifi.csv.CSVRecordSetWriter/index.html">CSVRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.19.1/org.apache.nifi.xml.XMLRecordSetWriter/index.html">XMLRecordSetWriter</a><br/><a href="../../../nifi-parquet-nar/1.19.1/org.apache.nifi.parquet.ParquetRecordSetWriter/index.html">ParquetRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.19.1/org.apache.nifi.json.JsonRecordSetWriter/index.html">JsonRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.19.1/org.apache.nifi.lookup.RecordSetWriterLookup/index.html">RecordSetWriterLookup</a></td><td id="description">The Record Writer to use in order to write Solr documents to FlowFiles. Must be set if "Records" is used as return type.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Solr Query</td><td>Solr Query</td><td></td><td id="allowable-values"></td><td id="description">A query to execute against Solr</td></tr><tr><td id="name"><strong>Date Field</strong></td><td>Date Field</td><td></td><td id="allowable-values"></td><td id="description">The name of a date field in Solr used to filter results</td></tr><tr><td id="name">Initial Date Filter</td><td>Initial Date Filter</td><td></td><td id="allowable-values"></td><td id="description">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'</td></tr><tr><td id="name">Return Fields</td><td>Return Fields</td><td></td><td id="allowable-values"></td><td id="description">Comma-separated list of field names to return</td></tr><tr><td id="name"><strong>Batch Size</strong></td><td>Batch Size</td><td id="default-value">100</td><td id="allowable-values"></td><td id="description">Number of rows per Solr query</td></tr><tr><td id="name">Kerberos Credentials Service</td><td>kerberos-credentials-service</td><td></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>KerberosCredentialsService<br/><strong>Implementation: </strong><a href="../../../nifi-kerberos-credentials-service-nar/1.19.1/org.apache.nifi.kerberos.KeytabCredentialsService/index.html">KeytabCredentialsService</a></td><td id="description">Specifies the Kerberos Credentials Controller Service that should be used for authenticating with Kerberos</td></tr><tr><td id="name">Kerberos User Service</td><td>kerberos-user-service</td><td></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>KerberosUserService<br/><strong>Implementations: </strong><a href="../../../nifi-kerberos-user-service-nar/1.19.1/org.apache.nifi.kerberos.KerberosPasswordUserService/index.html">KerberosPasswordUserService</a><br/><a href="../../../nifi-kerberos-user-service-nar/1.19.1/org.apache.nifi.kerberos.KerberosKeytabUserService/index.html">KerberosKeytabUserService</a><br/><a href="../../../nifi-kerberos-user-service-nar/1.19.1/org.apache.nifi.kerberos.KerberosTicketCacheUserService/index.html">KerberosTicketCacheUserService</a></td><td id="description">Specifies the Kerberos User Controller Service that should be used for authenticating with Kerberos</td></tr><tr><td id="name">Kerberos Principal</td><td>kerberos-principal</td><td></td><td id="allowable-values"></td><td id="description">The principal to use when specifying the principal and password directly in the processor for authenticating to Solr via Kerberos.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Kerberos Password</td><td>kerberos-password</td><td></td><td id="allowable-values"></td><td id="description">The password to use when specifying the principal and password directly in the processor for authenticating to Solr via Kerberos.<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name">Basic Auth Username</td><td>Username</td><td></td><td id="allowable-values"></td><td id="description">The username to use when Solr is configured with basic authentication.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Basic Auth Password</td><td>Password</td><td></td><td id="allowable-values"></td><td id="description">The password to use when Solr is configured with basic authentication.<br/><strong>Sensitive Property: true</strong><br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">SSL Context Service</td><td>SSL Context Service</td><td></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>SSLContextService<br/><strong>Implementations: </strong><a href="../../../nifi-ssl-context-service-nar/1.19.1/org.apache.nifi.ssl.StandardRestrictedSSLContextService/index.html">StandardRestrictedSSLContextService</a><br/><a href="../../../nifi-ssl-context-service-nar/1.19.1/org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a></td><td id="description">The Controller Service to use in order to obtain an SSL Context. This property must be set when communicating with a Solr over https.</td></tr><tr><td id="name"><strong>Solr Socket Timeout</strong></td><td>Solr Socket Timeout</td><td id="default-value">10 seconds</td><td id="allowable-values"></td><td id="description">The amount of time to wait for data on a socket connection to Solr. A value of 0 indicates an infinite timeout.</td></tr><tr><td id="name"><strong>Solr Connection Timeout</strong></td><td>Solr Connection Timeout</td><td id="default-value">10 seconds</td><td id="allowable-values"></td><td id="description">The amount of time to wait when establishing a connection to Solr. A value of 0 indicates an infinite timeout.</td></tr><tr><td id="name"><strong>Solr Maximum Connections</strong></td><td>Solr Maximum Connections</td><td id="default-value">10</td><td id="allowable-values"></td><td id="description">The maximum number of total connections allowed from the Solr client to Solr.</td></tr><tr><td id="name"><strong>Solr Maximum Connections Per Host</strong></td><td>Solr Maximum Connections Per Host</td><td id="default-value">5</td><td id="allowable-values"></td><td id="description">The maximum number of connections allowed from the Solr client to a single Solr host.</td></tr><tr><td id="name">ZooKeeper Client Timeout</td><td>ZooKeeper Client Timeout</td><td id="default-value">10 seconds</td><td id="allowable-values"></td><td id="description">The amount of time to wait for data on a connection to ZooKeeper, only used with a Solr Type of Cloud.</td></tr><tr><td id="name">ZooKeeper Connection Timeout</td><td>ZooKeeper Connection Timeout</td><td id="default-value">10 seconds</td><td id="allowable-values"></td><td id="description">The amount of time to wait when establishing a connection to ZooKeeper, only used with a Solr Type of Cloud.</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>The results of querying Solr</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.<h3>State management: </h3><table id="stateful"><tr><th>Scope</th><th>Description</th></tr><tr><td>CLUSTER</td><td>Stores latest date of Date Field so that the same data will not be fetched multiple times.</td></tr></table><h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component does not allow an incoming relationship.<h3>System Resource Considerations:</h3>None specified.</body></html> |