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.

NameDefault ValueAllowable ValuesDescription
Couchbase Cluster Controller ServiceController Service API:
CouchbaseClusterControllerService
Implementation:CouchbaseClusterService
A Couchbase Cluster Controller Service which manages connections to a Couchbase cluster.
Bucket NamedefaultThe name of bucket to access.
Document TypeJson
  • Json
  • Binary
The type of contents.
Document IdA static, fixed Couchbase document id, or an expression to construct the Couchbase document id.
Supports Expression Language: true

Relationships:

NameDescription
retryAll FlowFiles that cannot written to Couchbase Server but can be retried are routed to this relationship.
successAll FlowFiles that are written to Couchbase Server are routed to this relationship.
failureAll FlowFiles that cannot written to Couchbase Server and can't be retried are routed to this relationship.
originalThe original input file will be routed to this destination when it has been successfully processed.

Reads Attributes:

None specified.

Writes Attributes:

NameDescription
couchbase.clusterCluster where the document was retrieved from.
couchbase.bucketBucket where the document was retrieved from.
couchbase.doc.idId of the document.
couchbase.doc.casCAS of the document.
couchbase.doc.expiryExpiration of the document.
couchbase.exceptionIf 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.

See Also: