A newer version of this documentation is available.

View Latest

Release Notes

Standalone Connector vs. Plug-in

Starting with version 4.0 the connector is now a standalone process. The standalone distribution archives are named couchbase-elasticsearch-connector-, and download links are provided on this page.

Prior to version 4.0 the connector was implemented as an Elasticsearch plug-in. The plug-in distributions have archive names starting with elasticsearch-transport-couchbase-.

If you want to use the old plug-in, distributions may be downloaded from GitHub. Make sure to pick the archive whose es version component exactly matches your Elasticsearch version. For example, to use the 3.0.0 version of the plug-in with Elasticsearch 5.6.4, you would select elasticsearch-transport-couchbase-3.0.0-cypress-es5.6.4.zip.

Elasticsearch Connector 4.0.2 (2019-05-21)

This maintenance release fixes a bug that prevented some versions of Couchbase Server from rebalancing when the connector is running.

It also adds compatibility with the official Docker images for Elasticsearch 6.7.x and 7.0.x, and is the first version tested against OpenJDK 8 and OpenJDK 11.


  • CBES-122 Add support for OpenJDK

  • CBES-123 Support Elasticsearch 6.7 & 7.0 docker images

  • CBES-125 Suppress "types removal" warnings from Elasticsearch 7.0

Bug Fixes

  • CBES-128 Couchbase Server fails to rebalance if Elasticsearch connector is running

Elasticsearch Connector 4.0.1 (2019-04-15)

This maintenance release improves the stability of the connector and adds new configuration options.


  • CBES-90 Ability to use environment variables inside config

  • CBES-107 Misleading error message when can’t connect to Elasticsearch

  • CBES-110 Need document routing to support join

  • CBES-114 Allow saving checkpoints in a different bucket

Bug Fixes

  • CBES-117 Connector exits on values that fail to parse

Elasticsearch Connector 4.0.0 (2018-10-12)

New in this version

  • The connector is now a standalone process instead of an Elasticsearch plug-in.

  • Compatible with Elasticsearch versions 5 and 6.

  • Support for secure connections to Couchbase and Elasticsearch.

  • Tools for managing replication checkpoints.

  • A "rejection log" for documents Elasticsearch permanently refuses to index.

  • Configurable document structure (omit metadata if you don’t need it).

  • The connector now listens for document changes using the high performance Couchbase Database Change Protocol (DCP).

Things to be aware of

This is a major version upgrade. Because the plug-in and the standalone connector are so different, there is no online upgrade process. See the Migration documentation for details.
  • Parent-child relationships are no longer supported, as this feature was removed in ES 6.

  • Routing documents to specific Elasticsearch shards is not implemented. Please let us know if this feature is still relevant for your deployment.

Elasticsearch Plug-in 3.0.2 (2018-09-18)

Maintenance release for improved compatibility and stability.

Bug Fixes

  • CBES-82: NoClassDefFoundError under Java 9.

  • CBES-83: VersionConflictEngineException in storeUUID if document already exists. (Causes XDCR replication to be removed.)

Elasticsearch Plug-in 3.0.1 (2018-02-18)

The birch development line has been retired. The cypress line now supports all 5.x versions of Elasticsearch.

RegexParentSelector now reads the parent ID format from the correct config property (couchbase.parentSelector.documentTypesParentFormat.<type>). If you previously put the parent ID format in the documentTypeParentFields property as a workaround, please update your configuration.

The connector can now delete child documents and other documents that have custom routing. If you’re using RegexParentSelector then this feature has no additional overhead. Otherwise, for each document whose routing cannot be derived from the document ID, the connector creates a separate signpost document to record the routing. Be aware that child documents created by previous versions of the connector are not eligible for deletion, since they don’t have signposts (you’ll see "missing signpost" warnings in the log when the connector tries to delete those documents).

The signposts have a document type of couchbaseSignpost. The mapping for this type must store the contents of the meta field. This is already the case if you’re using the default mapping template included in the plug-in distribution.

Bug Fixes

  • CBES-49: RegexParentSelector reads parent ID format from wrong config property.

  • CBES-50: RoutingMissingException when deleting child documents.

Elasticsearch Plug-in 3.0.0 (2017-11-22)

With this release, the Couchbase plug-in for Elasticsearch moves to a new versioning and branch management strategy that allows for simultaneous releases across ES versions (see [Version Compatibility]). All the versions are expected to work and are supported. However, versions which have received more testing and are officially supported are:

  • 3.0.0-cypress-es5.6.4

  • 3.0.0-birch-es5.2.2

  • 3.0.0-alder-es2.4.0

Don’t be alarmed by the major version bump; upgrading from version 2.x of the plug-in should be seamless, and is recommended for all users. The code has just been relabeled for easier maintenance.

New Feature

  • Adds the couchbase.pipeline config for specifying the ingestion pipeline.


  • Improves logging for indexing errors.

  • Uses Dropwizard Metrics to collect and log richer stats.

Bug Fixes

  • CBES-48: Connection counter leak could cause spurious TooManyConcurrentConnections errors.

  • #153: ClassCastException error when the TTL is of type Long instead of Integer.

Known issues

The Elasticsearch Plug-in does not support IPv6. So to use the plug-in, the Couchbase Server and Elasticsearch clusters will need to run on instances which are addressable with IPv4.

Elasticsearch Plug-in 2.2 (2017-02)

This release note applies to the 2.2 version of the Elasticsearch Transport Plug-in (February 2017). It adds a number of bug fixes. See Installation and Configuration for versioning and compatibility information.

Elasticsearch Plug-in 2.1.1 (2015-09)

This release note applies to the 2.1.1 version of the Elasticsearch Transport Plug-in (September 2015). It adds compatibility with newer Elasticsearch versions up to 1.7.x, multiple new features, and quite a few bug fixes, including several that solve issues found in 2.1.0. In particular, this release fixes a long-standing bug with an incorrect concurrent bulk request counter, which could eventually cause the plug-in to stop accepting requests from Couchbase Server altogether.

Some configuration option-names changed.

Elasticsearch plug-in version Couchbase versions Elasticsearch versions


2.5.x - 4.x

1.3.0 - 1.7.x

Elasticsearch Plug-in 2.0 (2014-10)

This release note is for the Elasticsearch plug-in release 2.0 GA (October 2014). Elasticsearch plug-in version 2.0 is compatible with:

  • Elasticsearch 1.3.0.

  • Couchbase Server 3.0

  • Couchbase Server 2.5.x (backward compatible)

The new feature(s) available in Elasticsearch Plug-in v2.0:

  • Support more than one document type in Elasticsearch. (MB-12284)

The following are known issues:

  • The att_reason value for non-JSON documents changed from non-JSON mode to invalid_json. If a Couchbase cluster has a lot of deletes, the Elasticsearch log could fill up with a lot of messages. (CBES-31)

Elasticsearch Plug-in 1.3.0 (2014-04)

This release note is for the Elasticsearch plug-in release 1.3.0 GA (April 2014). This release is compatible only with Elasticsearch 1.0.1.

This release is compatible with Couchbase Server 2.5.x, and it is backward compatible with earlier 2.x releases.

  • Support for new XDCR checkpoint protocol. (CBES-26)

  • Fixed failure handling due to bounded queue with Elasticsearch 1.x. (CBES-27)

Elasticsearch Plug-in 1.2.0 (2013-10)

This release note is for the Elasticsearch plug-in release 1.2.0 GA (October 2013). This release adds compatibility with Elasticsearch 0.90.5.

This release is compatible with Couchbase Server 2.2, and it is backward compatible with earlier 2.x releases.

Elasticsearch Plug-in 1.1.0 (2013-08)

This release note is for the Elasticsearch plug-in release 1.1.0 GA (August 2013). This release adds compatibility with Elasticsearch 0.90.2.

Elasticsearch Plug-in 1.0.0 (2013-02)

This release note is for the Elasticsearch plug-in release 1.0.0 GA (February 2013). This is the first general availability (GA) release. It contains the following enhancements and bug fixes:

  • Now compatible with version 0.20.2 of Elasticsearch.

  • Now supports document expiration using Elasticsearch TTL.

  • Now supports XDCR conflict resolution to reduce bandwidth usage in some cases.

  • Fixed Couchbase index template to allow searching on the document metadata.

  • Fixed data corruption under high load. (CBES-11)

  • Fixed recognition of non-JSON documents. (CBES-11)

  • Improved log information when indexing stub documents.

Elasticsearch Plug-in 1.0.0 Beta (2013-02)

This is the beta release of the Couchbase plug-in for Elasticsearch 1.0.0 Beta (February 2013).