| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>GetRethinkDB</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;">GetRethinkDB</h1><h2>Description: </h2><p>Processor to get a JSON document from RethinkDB (https://www.rethinkdb.com/) using the document id. The FlowFile will contain the retrieved document</p><h3>Tags: </h3><p>rethinkdb, get, read, fetch</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>DB Name</strong></td><td>rethinkdb-dbname</td><td></td><td id="allowable-values"></td><td id="description">RethinkDB database to connect to</td></tr><tr><td id="name"><strong>Hostname</strong></td><td>rethinkdb-host</td><td id="default-value">localhost</td><td id="allowable-values"></td><td id="description">RethinkDB hostname</td></tr><tr><td id="name"><strong>DB Port</strong></td><td>rethinkdb-port</td><td id="default-value">28015</td><td id="allowable-values"></td><td id="description">RethinkDB database port to connect to</td></tr><tr><td id="name">Username</td><td>rethinkdb-username</td><td></td><td id="allowable-values"></td><td id="description">Username for accessing RethinkDB</td></tr><tr><td id="name">Password</td><td>rethinkdb-password</td><td></td><td id="allowable-values"></td><td id="description">Password for user<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name"><strong>Table name</strong></td><td>rethinkdb-table</td><td></td><td id="allowable-values"></td><td id="description">RethinkDB table to connect to</td></tr><tr><td id="name"><strong>Character Set</strong></td><td>rethinkdb-charset</td><td id="default-value">UTF-8</td><td id="allowable-values"></td><td id="description">Specifies the character set of the document data.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>Document Identifier</strong></td><td>rethinkdb-document-identifier</td><td></td><td id="allowable-values"></td><td id="description">A FlowFile attribute, or attribute expression used for determining RethinkDB key for the Flow File content<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>Read Mode</strong></td><td>rethinkdb-read-mode</td><td id="default-value">Single</td><td id="allowable-values"><ul><li>Single <img src="../../../../../html/images/iconInfo.png" alt="Read values from memory from primary replica (Default)" title="Read values from memory from primary replica (Default)"></img></li><li>Majority <img src="../../../../../html/images/iconInfo.png" alt="Read values committed to disk on majority of replicas" title="Read values committed to disk on majority of replicas"></img></li><li>Outdated <img src="../../../../../html/images/iconInfo.png" alt="Read values from memory from an arbitrary replica " title="Read values from memory from an arbitrary replica "></img></li></ul></td><td id="description">Read mode used for consistency<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>Max size of documents</strong></td><td>rethinkdb-max-document-size</td><td id="default-value">1 MB</td><td id="allowable-values"></td><td id="description">Maximum size of documents allowed to be posted in one batch</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>Sucessful FlowFiles are routed to this relationship</td></tr><tr><td>not_found</td><td>Document not found are routed to this relationship</td></tr><tr><td>failure</td><td>Failed FlowFiles are routed to this relationship</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>rethinkdb.error.message</td><td>RethinkDB error message</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component requires an incoming relationship.<h3>System Resource Considerations:</h3>None specified.<h3>See Also:</h3><p><a href="../org.apache.nifi.processors.rethinkdb.PutRethinkDB/index.html">PutRethinkDB</a>, <a href="../org.apache.nifi.processors.rethinkdb.DeleteRethinkDB/index.html">DeleteRethinkDB</a></p></body></html> |