| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>GetCouchbaseKey</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;">GetCouchbaseKey</h1><h2>Description: </h2><p>Get a document from Couchbase Server via Key/Value access. The ID of the document to fetch may be supplied by setting the <Document Id> property. NOTE: if the Document Id property is not set, the contents of the FlowFile will be read to determine the Document Id, which means that the contents of the entire FlowFile will be buffered in memory.</p><h3>Tags: </h3><p>nosql, couchbase, database, get</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>Couchbase Cluster Controller Service</strong></td><td>cluster-controller-service</td><td></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>CouchbaseClusterControllerService<br/><strong>Implementation: </strong><a href="../org.apache.nifi.couchbase.CouchbaseClusterService/index.html">CouchbaseClusterService</a></td><td id="description">A Couchbase Cluster Controller Service which manages connections to a Couchbase cluster.</td></tr><tr><td id="name"><strong>Bucket Name</strong></td><td>bucket-name</td><td id="default-value">default</td><td id="allowable-values"></td><td id="description">The name of bucket to access.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Document Type</strong></td><td>document-type</td><td id="default-value">Json</td><td id="allowable-values"><ul><li>Json</li><li>Binary</li></ul></td><td id="description">The type of contents.</td></tr><tr><td id="name">Document Id</td><td>document-id</td><td></td><td id="allowable-values"></td><td id="description">A static, fixed Couchbase document id, or an expression to construct the Couchbase document id.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Put Value to Attribute</td><td>put-to-attribute</td><td></td><td id="allowable-values"></td><td id="description">If set, the retrieved value will be put into an attribute of the FlowFile instead of a the content of the FlowFile. The attribute key to put to is determined by evaluating value of this property.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>retry</td><td>All FlowFiles failed to fetch from Couchbase Server but can be retried are routed to this relationship.</td></tr><tr><td>success</td><td>Values retrieved from Couchbase Server are written as outgoing FlowFiles content or put into an attribute of the incoming FlowFile and routed to this relationship.</td></tr><tr><td>failure</td><td>All FlowFiles failed to fetch from Couchbase Server and not retry-able are routed to this relationship.</td></tr><tr><td>original</td><td>The original input FlowFile is routed to this relationship when the value is retrieved from Couchbase Server and routed to 'success'.</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>couchbase.cluster</td><td>Cluster where the document was retrieved from.</td></tr><tr><td>couchbase.bucket</td><td>Bucket where the document was retrieved from.</td></tr><tr><td>couchbase.doc.id</td><td>Id of the document.</td></tr><tr><td>couchbase.doc.cas</td><td>CAS of the document.</td></tr><tr><td>couchbase.doc.expiry</td><td>Expiration of the document.</td></tr><tr><td>couchbase.exception</td><td>If Couchbase related error occurs the CouchbaseException class name will be captured here.</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><table id="system-resource-considerations"><tr><th>Resource</th><th>Description</th></tr><tr><td>MEMORY</td><td>An instance of this component can cause high usage of this system resource. Multiple instances or high concurrency settings may result a degradation of performance.</td></tr></table></body></html> |