adding sample.yaml

Author: Windfarer

README.md

@@ -36,7 +36,7 @@ pip install py-mysql-elasticsearch-sync
 ```
 
 ## 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.
+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

src/sample.yaml

@@ -0,0 +1,40 @@
+# The mysql database which you want to sync
+mysql:
+  host: 127.0.0.1
+  port: 3306
+  user: foo
+  password: bar
+  db: mydb
+  table: mytable
+  server_id: 1  # this should be unique
+
+elastic:
+  host: 127.0.0.1
+  port: 9200
+  bulk_size: 100
+  index: article
+  type: article
+
+# If you want to map your column, put the column name as the value, and es field name as the key,
+# Particularly , if you set _id as follows, it will use myid column as the index doc's id, or ES will generate an id as default
+mapping:
+  _id: myid
+  es_field_name: mysql_column_name
+
+# The log file's path
+logging:
+  file: mylog.log
+
+# The record file's path, which record the latest synced binlog file and position
+binlog_sync:
+  record_file: binlog.info
+
+# If you want to email notification when error occurs, fill this
+email:
+  from: # the sender's email, uses smtp protocol
+    host: smtp.example.com
+    username: sender@example.com
+    password: senderpassword
+  to:  # a list of notification recipients
+    - first_recipient@example.com
+    - second_recipient@example.com