Quickstart

Quickstart

A short guide for the impatient!

Prerequisites:

A running MySQL database test, with user test and password test, a table orders

A terminal / console with commands curl and unzip

Internet access (of course)

Let's go!

1. Download elasticsearch (current version is 0.19.8, check for the most recent version on http://elasticsearch.org) from

   curl -OL https://github.com/downloads/elasticsearch/elasticsearch/elasticsearch-0.19.10.zip

2. Unpack zip file into you favorite elasticsearch directory, we call it $ES_HOME

   cd $ES_HOME

   unzip path/to/elasticsearch-0.19.10.zip

3. Install JDBC river plugin (current version is 1.3.2, check for the most recent version, and if you have the file permissions to write into the plugins folder). If you have installed a JDBC river plugin before, it is recommended to remove the folder plugins/river-jdbc before installing a new version. (Note: If you're using a version of elasticsearch >= 0.90.0, you need to use at least version 2.2.0 of the river-jdbc plugin).

   ./bin/plugin -url http://bit.ly/10FJhEd -install river-jdbc

4. Download MySQL JDBC driver (current version is 5.1.21, check for the most recent version)

   curl -OL http://dev.mysql.com/get/Downloads/Connector-J/mysql-connector-java-5.1.21.zip/from/http://cdn.mysql.com/

5. Add MySQL JDBC driver jar to JDBC river plugin directory

   cp mysql-connector-java-5.1.21-bin.jar $ES_HOME/plugins/river-jdbc/

6. Start elasticsearch in terminal window with logging on the console

   ./bin/elasticsearch -f

7. Start another terminal window, and create a new JDBC river with name my_jdbc_river with this curl command

   curl -XPUT 'localhost:9200/_river/my_jdbc_river/_meta' -d '{
       "type" : "jdbc",
       "jdbc" : {
           "driver" : "com.mysql.jdbc.Driver",
           "url" : "jdbc:mysql://localhost:3306/test",
           "user" : "test",
           "password" : "test",
           "sql" : "select * from orders"
       },
       "index" : {
           "index" : "jdbc",
           "type" : "jdbc"
       }
   }'
   

8. The river runs! Watch the log on the elasticsearch console for the river activity. When the river fetched the data and is going to wait for the next cycle (which is by default 60 minutes ahead), you can query your elasticsearch node for the data you just indexed with the following curl command

   curl -XGET 'localhost:9200/jdbc/jdbc/_search?pretty&q=*'

9. Enjoy the result!

10. If you want to stop the my_jdbc_river river fetching data from the orders table after the quick demonstration, use this curl command:

    curl -XDELETE 'localhost:9200/_river/my_jdbc_river'

What next?

Now, if you want more fine-tuning, you can drop the index jdbc, change the mapping, change the index name or type name, change the river creation settings, play with the data fetch interval - whatever you like.