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 Python3.

## 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. Python3
This tool is written in Python3.4, so you must install Python3.4 first, by following [this guide](https://docs.python.org/3.4/using/index.html)
##### 2. 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.
##### 3. mysqldump
And then, mysqldump is required.


##### 4. this tool
Then clone this repo and install dependencies

```
git clone https://github.com/zhongbiaodev/py-mysql-elasticsearch-sync.git

cd py-mysql-elasticsearch-sync

pip3 install -r requirements.txt
```

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

## Running
Simply run command

```
python3 main.py 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

```
python3 main.py 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
- [ ] Packaging
- [ ] 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.2.1.tar.gz (7.2 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.2.1-py3-none-any.whl (7.3 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for py-mysql-elasticsearch-sync-0.2.1.tar.gz
Algorithm Hash digest
SHA256 c886c3c8ed2cd47f8846153a0b2e25eb72a900093d2d39dde058a3fba146f723
MD5 58d4f4b7905ba6b6a8cd6f25a5dbb1d6
BLAKE2b-256 b39aceeb0f2f99647c670ab26225de13492fa4f6bee315220819aa4a274e038a

See more details on using hashes here.

File details

Details for the file py_mysql_elasticsearch_sync-0.2.1-py3-none-any.whl.

File metadata

File hashes

Hashes for py_mysql_elasticsearch_sync-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0d0f42a5efb9b16fee4828b01d0dac40a5e7dbeabeb2e46535c48ccaa8d90412
MD5 ebe524a047e5437892f8506e1815e9b3
BLAKE2b-256 271cc184b166ad0354686470e1cd3c379667a497d91f0d2cf38969b9b777b963

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