Couchbase Lookup

Supported pipeline types:
  • Data Collector

The Couchbase Lookup processor looks up documents in Couchbase Server and returns values to fields in the record. For information about supported versions, see Supported Systems and VersionsSupported Systems and Versions in the Data Collector documentation.

Use the Couchbase Lookup processor to enrich records with additional data. For example, suppose Couchbase Server has multiple department documents, each listing the employees in a department. You can configure a pipeline to store the Couchbase document key, which uniquely identifies each department, in a record header attribute. Then, include a Couchbase Lookup processor to find the matching document and return the values to a new department_employees field in the record.

The Couchbase Lookup processor can look up documents using the document key or the Couchbase Server query language, N1QL. For key lookups, the processor can return the data from the entire document to a specified map field. Alternatively, for both key and N1QL lookups, the processor can return data from sub-documents to specified map fields. For N1QL lookups, when a lookup results in multiple matched documents, the Couchbase Lookup processor can return values from the first matching document or return values from all matching documents in separate records.

When you configure the Couchbase Lookup processor, you enter connection information, such as the nodes and bucket to connect to, as well as timeout properties for the connection. Optionally, you can enable TLS for the connection. You also enter information to authenticate with Couchbase Server.