GetCouchbaseKey

Description:

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.

Tags:

nosql, couchbase, database, get

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 Name	API Name	Default Value	Allowable Values	Description
Couchbase Cluster Controller Service	cluster-controller-service		Controller Service API: CouchbaseClusterControllerService Implementation: CouchbaseClusterService	A Couchbase Cluster Controller Service which manages connections to a Couchbase cluster.
Bucket Name	bucket-name	default		The name of bucket to access. Supports Expression Language: true (will be evaluated using variable registry only)
Document Type	document-type	Json	Json Binary	The type of contents.
Document Id	document-id			A static, fixed Couchbase document id, or an expression to construct the Couchbase document id. Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Put Value to Attribute	put-to-attribute			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. Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)

Relationships:

Name	Description
retry	All FlowFiles failed to fetch from Couchbase Server but can be retried are routed to this relationship.
success	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.
failure	All FlowFiles failed to fetch from Couchbase Server and not retry-able are routed to this relationship.
original	The original input FlowFile is routed to this relationship when the value is retrieved from Couchbase Server and routed to 'success'.

Reads Attributes:

None specified.

Writes Attributes:

Name	Description
couchbase.cluster	Cluster where the document was retrieved from.
couchbase.bucket	Bucket where the document was retrieved from.
couchbase.doc.id	Id of the document.
couchbase.doc.cas	CAS of the document.
couchbase.doc.expiry	Expiration of the document.
couchbase.exception	If Couchbase related error occurs the CouchbaseException class name will be captured here.

State management:

This component does not store state.

Restricted:

This component is not restricted.

Input requirement:

This component requires an incoming relationship.

System Resource Considerations:

Resource	Description
MEMORY	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.