Skip to main content

MySQL to Elasticsearch sync tool

Project description

# py-mysql-elasticsearch-sync
Simple and fast MySQL to Elasticsearch sync tool, written in Python.

## Introduction
This tool helps you to initialize MySQL dump table to Elasticsearch by parsing mysqldump, then incremental sync MySQL table to Elasticsearch by processing MySQL Binlog.
Also, during the binlog syncing, this tool will save the binlog sync position, so that it is easy to recover after this tool being shutdown for any reason.

## Installation
By following these steps.

##### 1. ibxml2 and libxslt
Also, this tool depends on python lxml package, so that you should install the lxml's dependecies correctly, the libxml2 and libxslt are required.

For example, in CentOS:

```
sudo yum install libxml2 libxml2-devel libxslt libxslt-devel
```

Or in Debian/Ubuntu:

```
sudo apt-get install libxml2-dev libxslt-dev python-dev
```

See [lxml Installation](http://lxml.de/installation.html) for more infomation.
##### 2. mysqldump
And then, mysqldump is required.(and enable binlog)


##### 3. this tool
Then install this tool

```
pip install py-mysql-elasticsearch-sync
```

## Configuration
There is a [sample config](https://github.com/zhongbiaodev/py-mysql-elasticsearch-sync/blob/master/src/sample.yaml) file in repo, you can start by editing it.

## Running
Simply run command

```
es-sync path/to/your/config.yaml
```
and the tool will dump your data as stream to sync, when dump is over, it will start to sync binlog.

The latest synced binlog file and position are recorded in your info file which is configured in your config file. You can restart dump step by remove it, or you can change sync position by edit it.

Or if you but want to load it from your own dumpfile. You should dump your table first as xml format(by adding ```-X```option to your mysqldump command)

then

```
es-sync path/to/your/config.yaml --fromfile
```
to start sync, when xml sync is over, it will also start binlog sync.

## Deployment
We provide an upstart script to help you deploy this tool,since we use virtualenv for requirements isolation, you must edit it for your own condition, besides, you can deploy it in your own way.

## TODO
- [ ] MultiIndex Supporting
- [ ] Multi table Supporting

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

py-mysql-elasticsearch-sync-0.3.2.tar.gz (7.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

py_mysql_elasticsearch_sync-0.3.2-py2.py3-none-any.whl (7.6 kB view details)

Uploaded Python 2Python 3

File details

Details for the file py-mysql-elasticsearch-sync-0.3.2.tar.gz.

File metadata

File hashes

Hashes for py-mysql-elasticsearch-sync-0.3.2.tar.gz
Algorithm Hash digest
SHA256 75e30f637b5b77ea24ae9759a03610dff9557ebafb1e569b5a40340f398cd162
MD5 8e0d6126adadad61b5a0618533971a56
BLAKE2b-256 ba6ac5bbdec5d90273bfde4c6d15453e83876e30b11dd4ec3511934ba564c291

See more details on using hashes here.

File details

Details for the file py_mysql_elasticsearch_sync-0.3.2-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for py_mysql_elasticsearch_sync-0.3.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 59736a4ff7bd44dc50d4f78bd61fdc672c0eb953809be7d9f0b9ae9977c18042
MD5 faf144d93d3f82c8bd087386a2dfea85
BLAKE2b-256 9c045d191c2423265a22e691144bdd5d8bdd7f2485b73855ff7d1d292efd833f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page