You are here:
< Back


Getting MongoSluice up and running is very simple.  It is best recommended that MongoSluice is run on its own machine, but it will work well on a Mongo machine or SQL machine as well.  Here is a brief overview of the steps that must be taken in order to make MongoSluice work (assuming that you are running three separate machines):

  1. Linux/Windows machine running an instance of SQL
  2. Linux/Windows machine running an instance of MongoDB
  3. Linux/Windows machine containing MongoSluice (at least 4 GB of RAM recommended)


The node that contains MongoSluice ought to have access to the nodes running instances of SQL and MongoDB.  This will require making a port accessible to the MongoSluice machine on each of the nodes.  Make sure that your IP address is not bound to only localhost and that your firewalls are not blocking MongoSluice.  DigitalOcean offers some great tutorials on this.  To check that you have correctly made a connection between the MongoSluice node and the other two nodes, try mongo –host <ip>:27017 and mysql –host <ip> (assuming it is a MySQL connection).

After you have tested to make sure that your connection between your MongoSluice node and the two data housing nodes is successful, you are ready to move on to the next step.


Setting Up MongoSluice

On your MongoSluice node, change your directory to the MongoSluice root directory and then again to conf.  Here, you will see three files:

  1. mongoconnections.json  
  3. sqlconnections.json

Using your favorite text editor, open mongoconnections.  Now, in quotes, write the name that you would like to assign the connection followed by a colon and brackets that enclose the MongoSluice node’s IP and port.  Here is an example of how it ought to look:


Now, open sqlconnections.json.  Write the name that you would like to assign the connection, followed by “dbConnection” and then the correct JDBC URL for your database.  The full list of correct connection URLs can be located here.  An example of the MySQL connection is located below:



Running MongoSluice

Finally, you are ready to run MongoSluice.  Still on the MongoSluice machine, change your directory back to MongoSluice’s root directory and then to bin.  Here you will see two executable files: one for Linux and one for Windows.  You are now ready to run MongoSluice!

See the docs for more info on understanding the MongoSluice commands.


Confirming Configuration Via Test Data Set

Go ahead to your first assignment: Test Run Using MovieDetails