Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ozlerhakan/mongolastic

:traffic_light: A dataset migration tool from MongoDB to Elasticsearch and vice versa.
https://github.com/ozlerhakan/mongolastic

connector converter elasticsearch java map migration mongodb

Last synced: 1 day ago
JSON representation

:traffic_light: A dataset migration tool from MongoDB to Elasticsearch and vice versa.

Awesome Lists containing this project

README 

        
= Mongolastic

:version: v1.4.3



image:https://travis-ci.org/ozlerhakan/mongolastic.svg?branch=master["Build Status", link="https://travis-ci.org/ozlerhakan/mongolastic"]

image:https://api.codacy.com/project/badge/Grade/8d768c2fc37246019115e4d090a33b98["Codacy code quality", link="https://www.codacy.com/app/ozlerhakan/mongolastic?utm_source=github.com&utm_medium=referral&utm_content=ozlerhakan/mongolastic&utm_campaign=Badge_Grade"]

image:https://img.shields.io/docker/pulls/ozlerhakan/mongolastic.svg["Docker Pulls,link="https://hub.docker.com/r/ozlerhakan/mongolastic"]

image:https://img.shields.io/github/release/ozlerhakan/mongolastic.svg[]

image:https://img.shields.io/badge/mongo.java.driver-3.4.2-brightgreen.svg[] image:https://img.shields.io/badge/elastic.java.driver-6.2.4-brightgreen.svg[]

image:https://img.shields.io/badge/license-MIT-blue.svg[]



Mongolastic enables you to migrate your datasets from a mongod node to an elasticsearch node and vice versa. Since mongo and elastic servers can run with different characteristics, the tool provides several optional and required features to ably connect them. Mongolastic works with a yaml or json configuration file to begin a migration process. It reads your demand on the file and start syncing data in the specified direction.



== How it works



First, you can either pull the corresponding image of the app from https://hub.docker.com/r/ozlerhakan/mongolastic/[Docker Hub]



Supported tags and respective Dockerfile links:



*  `_1.4_`, `_1.4.4_`, `_latest_` https://github.com/ozlerhakan/mongolastic/blob/master/Dockerfile[_(master/Dockerfile)_]

*  `_1.4.3_` https://github.com/ozlerhakan/mongolastic/blob/0dacd80cbdf7b5b7b282bf6dd89ede8558021577/Dockerfile[_(1.4.2/Dockerfile)_]



or download the latest https://github.com/ozlerhakan/mongolastic/releases/download/{version}/mongolastic.jar[mongolastic.jar] file.



Second, create a yaml or json file which must contain the following structure:



[source,yaml]

----

misc:

    dindex:

        name:       <1>

        as:         <2>

    ctype:

        name:       <3>

        as:         <4>

    direction: (em | me)    <5>

    batch:          <6>

    dropDataset:      <7>

mongo:

    host:       <8>

    port:           <9>

    query: "mongo-query"    <10>

    project: "projection"   <11>

    auth:                   <12>

        user: 

        pwd: "password"

        source: 

        mechanism: ( plain | scram-sha-1 | x509 | gssapi | cr )

elastic:

    host:      <13>

    port:          <14>

    dateFormat: "" <15>

    longToString:    <16>

    clusterName:   <17>

    auth:                  <18>

        user: 

        pwd: "password"

----

<1>  the _database/index name_ to connect to.

<2>  another _database/index name_ in which documents will be located in the target service (*Optional*)

<3>  the _collection/type name_ to export.

<4>  another _collection/type name_ in which indexed/collected documents will reside in the target service (*Optional*)

<5>  direction of the data transfer. the default direction is me (that is, mongo to elasticsearch). You can skip this option if your data move from mongo to es.

<6>  Override the default batch size which is normally 200. (*Optional*)

<7>  configures whether or not the target table should be dropped prior to loading data. Default value is true (*Optional*)

<8>  the name of the host machine where the `mongod` is running.

<9>  the port where the `mongod` instance is listening.

<10>  data will be transferred based on a json mongodb query (*Optional*)

<11> with 1.4.1, you can manipulate documents that will be migrated from mongo to es based on the https://docs.mongodb.com/manual/reference/operator/aggregation/project/[`$project`] operator (*Optional*)

<12> as of v1.3.5, you can access an auth mongodb by giving auth configuration. (*Optional*)

<13> the name of the host machine where the `elastic node` is running.

<14> the *transport* port where the transport module will communicate with the running elastic node. E.g. *9300* for node-to-node communication.

<15> a custom formatter for Date fields rather than the default DateCodec (*Optional*)

<16> serialize long value as a string for backwards compatibility with other tools (*Optional*)

<17> connect to a spesific elastic cluster (*Optional*)

<18> as of v1.3.9, you can access an auth elastic search by giving auth configuration. (*Optional*)



---



Alternatively, a JSON file can be specified as a mongolastic configuration file including the same YAML file structure above.



[source,json]

----

{

	"misc": {

		"dindex": {

			"name": "twitter",

			"as": "media"

		},

		"ctype": {

			"name": "tweets",

			"as": "posts"

		},

		"direction": "me",

		"batch": 400,

		"dropDataset": true

	},

	"mongo": {

		"host": "127.0.0.1",

		"port": 27017,

		"query": "{ lang: 'en' }",

		"project": "{ user:1, name:'$user.name', location: { $substr: [ '$user.location', 10, 15 ] }}",

		"auth": {

			"user": "joe",

			"pwd": "1234",

			"source": "twitter",

			"mechanism": "scram-sha-1"

		}

	},

	"elastic": {

		"host": "127.0.0.1",

		"port": 9300,

		"dateFormat": "yyyy-MM-dd",

		"longToString": true,

		"auth": {

			"user": "joe",

			"pwd": "4321"

		}

	}

}

----



== Example #1



The following files have the same configuration details:



.yaml file

[source,yaml]

----

misc:

    dindex:

        name: twitter

        as: kodcu

    ctype:

        name: tweets

        as: posts

mongo:

    host: localhost

    port: 27017

    query: "{ 'user.name' : 'kodcu.com'}"

elastic:

    host: localhost

    port: 9300

----



.json file

[source,json]

----

{

	"misc": {

		"dindex": {

			"name": "twitter",

			"as": "kodcu"

		},

		"ctype": {

			"name": "tweets",

			"as": "posts"

		}

	},

	"mongo": {

		"host": "localhost",

		"port": 27017,

		"query": "{ 'user.name' : 'kodcu.com'}"

	},

	"elastic": {

		"host": "localhost",

		"port": 9300

	}

}

----



the config says that the transfer direction is from mongodb to elasticsearch, mongolastic first looks at the _tweets_ collection, where the _user name_ is _kodcu.com_, of the _twitter_ database located on a mongod server running on default host interface and port number. If It finds the corresponding data, It will start copying those into an elasticsearch environment running on default host and transport number. After all, you should see a type called _"posts"_ in an index called _"kodcu"_ in the current elastic node. Why the index and type are different is because "dindex.as" and "ctype.as" options were set, these indicates that your data being transferred exist in _posts_ type of the _kodcu_ index.



After downloading the jar or pulling the image and providing a conf file, you can either run the tool as:



    $ java -jar mongolastic.jar -f config.file



__or__



    $ docker run --rm -v $(PWD)/config.file:/config.file --net host ozlerhakan/mongolastic: config.file



== Example #2



Using the project field, you are able to manipulate documents when migrating them from mongodb to elasticsearch. For more examples about the `$project` operator of the aggregation pipeline, take a look at its https://docs.mongodb.com/manual/reference/operator/aggregation/project/[documentation].



[source,yaml]

----

misc:

    dindex:

        name: twitter

    ctype:

        name: tweets

mongo:

    host: 192.168.10.151

    port: 27017

    project: "{ user: 1, name: '$user.name', location: { $substr: [ '$user.location', 10, 15 ] }}" <1>

elastic:

    host: 192.168.10.152

    port: 9300

----

<1> the migrated documents will include the user field and contain new fields `name` and `location`.



NOTE: Every attempt of running the tool drops the mentioned db/index in the target environment unless the dropDataset parameter is configured otherwise.



== License



Mongolastic is released under http://showalicense.com/?hide_explanations=false&year=2015&fullname=Kodcu.com#license-mit[MIT].