blob: e781e3b19a7b1524a6a8efd1e20c15ac08ac0043 [file] [log] [blame]
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ConfluentSchemaRegistry</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;">ConfluentSchemaRegistry</h1><h2>Description: </h2><p>Provides a Schema Registry that interacts with the Confluent Schema Registry so that those Schemas that are stored in the Confluent Schema Registry can be used in NiFi. The Confluent Schema Registry has a notion of a "subject" for schemas, which is their terminology for a schema name. When a Schema is looked up by name by this registry, it will find a Schema in the Confluent Schema Registry with that subject.</p><h3>Tags: </h3><p>schema, registry, confluent, avro, kafka</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, whether a property supports the <a href="../../../../../html/expression-language-guide.html">NiFi Expression Language</a>, 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 <strong>nifi.properties</strong> file has an entry for the property <strong>nifi.sensitive.props.key</strong>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Schema Registry URLs</strong></td><td id="default-value">http://localhost:8081</td><td id="allowable-values"></td><td id="description">A comma-separated list of URLs of the Schema Registry to interact with<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></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>SSLContextService<br/><strong>Implementations: </strong><a href="../../../nifi-ssl-context-service-nar/1.18.0/org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a><br/><a href="../../../nifi-ssl-context-service-nar/1.18.0/org.apache.nifi.ssl.StandardRestrictedSSLContextService/index.html">StandardRestrictedSSLContextService</a></td><td id="description">Specifies the SSL Context Service to use for interacting with the Confluent Schema Registry</td></tr><tr><td id="name"><strong>Communications Timeout</strong></td><td id="default-value">30 secs</td><td id="allowable-values"></td><td id="description">Specifies how long to wait to receive data from the Schema Registry before considering the communications a failure</td></tr><tr><td id="name"><strong>Cache Size</strong></td><td id="default-value">1000</td><td id="allowable-values"></td><td id="description">Specifies how many Schemas should be cached from the Schema Registry</td></tr><tr><td id="name"><strong>Cache Expiration</strong></td><td id="default-value">1 hour</td><td id="allowable-values"></td><td id="description">Specifies how long a Schema that is cached should remain in the cache. Once this time period elapses, a cached version of a schema will no longer be used, and the service will have to communicate with the Schema Registry again in order to obtain the schema.</td></tr><tr><td id="name">Authentication Type</td><td id="default-value">NONE</td><td id="allowable-values"><ul><li>BASIC</li><li>NONE</li></ul></td><td id="description">HTTP Client Authentication Type for Confluent Schema Registry</td></tr><tr><td id="name">Username</td><td></td><td id="allowable-values"></td><td id="description">Username for authentication to Confluent Schema Registry<br/><br/><strong>This Property is only considered if </strong><strong>the [Authentication Type] Property has a value of "BASIC".</strong></td></tr><tr><td id="name">Password</td><td></td><td id="allowable-values"></td><td id="description">Password for authentication to Confluent Schema Registry<br/><strong>Sensitive Property: true</strong><br/><br/><strong>This Property is only considered if </strong><strong>the [Authentication Type] Property has a value of "BASIC".</strong></td></tr></table><h3>Dynamic Properties: </h3><p>Supports Sensitive Dynamic Properties: <strong>No</strong></p><p>Dynamic Properties allow the user to specify both the name and value of a property.<table id="dynamic-properties"><tr><th>Name</th><th>Value</th><th>Description</th></tr><tr><td id="name">request.header.*</td><td id="value">String literal, may not be empty</td><td>Properties that begin with 'request.header.' are populated into a map and passed as http headers in REST requests to the Confluent Schema Registry<br/><strong>Supports Expression Language: false</strong></td></tr></table></p><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>System Resource Considerations:</h3>None specified.</body></html>