Mongo-Connector doc manager for elasticsearch 2.x
Branch: master
Clone or download
Type Name Latest commit message Commit time
Failed to load latest commit information.
tests Drop support for Python 3.3 and earlier. Nov 4, 2018
.flake8 Fix flake8 warnings about line length now that black uses 88. Nov 4, 2018
.travis.yml Drop support for Python 3.3 and earlier. Nov 4, 2018
CHANGELOG.rst Drop support for Python 3.3 and earlier. Nov 4, 2018
LICENSE Moved elasticsearch 2.x doc manager for mongo-connector into separate… Mar 8, 2016
README.rst Update README to reflect tox test runner. Nov 4, 2018
pyproject.toml Discover files and version the package using setuptools_scm Nov 4, 2018
setup.cfg Merge branch 'master' into feature/auto-version Nov 4, 2018
tox.ini Update README to reflect tox test runner. Nov 4, 2018



The mongo-connector project originated as a MongoDB mongo-labs project and is now community-maintained under the custody of YouGov, Plc.

View build status

Getting Started

This package is a document manager for mongo-connector that targets Elasticsearch versions 2.x and 5.x -- don't let the name fool you! For information on running mongo-connector with Elasticsearch, please see the MongoConnector Usage with Elasticsearch wiki page.


The installation of the elastic2-doc-manager depends on which version of Elasticsearch you are targeting.

Elasticsearch 1.x

This is the document manager for Elasticsearch 2.x and 5.x. If you want to target Elasticsearch 1.x, please install the elastic-doc-manager.

Elasticsearch 2.x

For use with an Elasticsearch 2.x server, install with pip:

pip install 'elastic2-doc-manager[elastic2]'

Elasticsearch 5.x

For use with an Elasticsearch 5.x server, install with:

pip install 'elastic2-doc-manager[elastic5]'


Version 0.3.0 added support for Elasticsearch 5.x.

Amazon Elasticsearch Service

To use with Amazon Elasticsearch Service, you must install the required AWS dependencies along with the version of Elasticsearch:

pip install 'elastic2-doc-manager[elastic2,aws]'


You can also install the development version of elastic2-doc-manager manually:

git clone
pip install -e './elastic2-doc-manager[elastic2]'

You may have to run pip with sudo, depending on where you're installing and what privileges you have.


Please note that before mongo-connector version 2.2.2, the elastic

doc manager was packaged with mongo-connector and only supported Elasticsearch 1.x.

Running the tests


  1. Copy of the Elastic 2.x Document Manager Github repository

The tests are not included in the package from PyPI and can only be acquired by cloning this repository on Github:

git clone
  1. Tox
Install tox.
  1. Environment variables
There are a few influential environment variables that affect the tests. These are defined in the tox.ini.

All the tests live in the tests directory.

Running tests on the command-line

While the tests take care of setting up and tearing down MongoDB clusters on their own, make sure to start Elasticsearch before doing a full test run!

You can run all the tests with one command (this works in all supported Python versions):


Error messages

Some of the tests are meant to generate lots of ERROR-level log messages, especially the rollback tests. mongo-connector logs exceptions it encounters while iterating the cursor in the oplog, so we see these in the console output while MongoDB clusters are being torn apart in the tests. As long as all the tests pass with an OK message, all is well.