Put a document to Couchbase Server via Key/Value access.


nosql, couchbase, database, put


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 NameAPI NameDefault ValueAllowable ValuesDescription
Couchbase Cluster Controller Servicecluster-controller-serviceController Service API:
Implementation: CouchbaseClusterService
A Couchbase Cluster Controller Service which manages connections to a Couchbase cluster.
Bucket Namebucket-namedefaultThe name of bucket to access.
Supports Expression Language: true (will be evaluated using variable registry only)
Document Typedocument-typeJson
  • Json
  • Binary
The type of contents.
Document Iddocument-idA 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)
Persist Topersist-toNONE
  • NONE
  • ONE
  • TWO
  • FOUR
Durability constraint about disk persistence.
Replicate Toreplicate-toNONE
  • NONE
  • ONE
  • TWO
Durability constraint about replication.


retryAll FlowFiles failed to be 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 failed to be written to Couchbase Server and not retry-able are routed to this relationship.

Reads Attributes:

uuidUsed as a document id if 'Document Id' is not specified

Writes Attributes:

couchbase.clusterCluster where the document was stored.
couchbase.bucketBucket where the document was stored.
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.


This component is not restricted.

Input requirement:

This component requires an incoming relationship.

System Resource Considerations:

MEMORYAn instance of this component can cause high usage of this system resource. Multiple instances or high concurrency settings may result a degradation of performance.