The mongo-connector project originated as a MongoDB mongo-labs project and is now community-maintained under the custody of YouGov, Plc.
.. image:: https://travis-ci.org/yougov/elastic2-doc-manager.svg?branch=master :alt: View build status :target: https://travis-ci.org/yougov/elastic2-doc-manager
This package is a document manager for
mongo-connector <https://github.com/yougov/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 <https://github.com/yougov/mongo-connector/wiki/Usage%20with%20ElasticSearch>
The installation of the elastic2-doc-manager depends on which version of Elasticsearch you are targeting.
This is the document manager for Elasticsearch 2.x and 5.x. If you
want to target Elasticsearch 1.x, please install the
For use with an Elasticsearch 2.x server, install with
pip install 'elastic2-doc-manager[elastic2]'
For use with an Elasticsearch 5.x server, install with::
pip install 'elastic2-doc-manager[elastic5]'
.. note:: Version 0.3.0 added support for Elasticsearch 5.x.
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 https://github.com/yougov/elastic2-doc-manager.git pip install -e './elastic2-doc-manager[elastic2]'
You may have to run
sudo, depending on where you're
installing and what privileges you have.
.. note:: 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.
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 https://github.com/yougov/elastic2-doc-manager 2. Tox Install `tox <https://pypi.org/project/tox>`_. 2. 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)::
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.