Skip to main content
Pentaho Documentation

CouchDB Input

The CouchDB Input step retrieves all documents from a view in a design document for a specified CouchDB database. The resulting output is a single string-type field named JSON. The field contains a row for each received document. See the CouchDB guide for more information on CouchDB, design documents, and views.

AEL Considerations

When using the CouchDB Input step with the Adaptive Execution Layer (AEL), the following factors affect performance and results:

  • Spark processes null values differently than the Pentaho engine. You will need to adjust your transformation to successfully process null values according to Spark's processing rules.
  • Metadata injection is not supported for steps running on AEL.


Enter the following information in the transformation step fields:

Option Description
Step Name Specify the unique name of the CouchDB Input step on the canvas. You can customize the name or leave it as the default.
Host name or IP Specify the host name for the connection to your database.
Port Specify the port number for the connection to your database.
Database Specify the name of the incoming database.
Design document Identify the source design document. Design documents are a special type of CouchDB document that contains application code. See CouchDB Design Documents for more information.
View name Identify the source CouchDB view. See CouchDB Views for more information.
Authentication user Specify the username required to access the database.
Authentication password Specify the password required to access the database.

Metadata Injection Support

All fields of this step support metadata injection. You can use this step with ETL Metadata Injection to pass metadata to your transformation at runtime.

Metadata injection is not supported for steps running on the Adaptive Execution Layer (AEL).