Quick Start: Local Mode

This section is a tutorial for installing Squall/Storm on your local machine.

1. Prerequisites: Make sure that you have sbt and Java v7 (or higher) installed, and that they are on your system PATH. To check the versions (and their presence on system PATH), please run java -version. If you don't have the appropriate versions, please install them using instructions for your platform. sbt and Java are available from the central repositories (provided by your operating system distribution).

2. Squall is under continuous development at this point, and therefore to benefit from the latest improvements it is better to directly clone the repository from GitHub:

   $ git clone https://github.com/epfldata/squall.git
   

3. To install Squall, simply run the following command in the bin directory ( you need working internet connection to complete this step, in order to download some libraries ):

   $ ./install.sh
   

   This script downloads apache-storm-0.9.4 to the root directory of your Squall installation. Then, it compiles Squall (the output is squall-core/target/squall-0.2.0.jar) and downloads all the dependencies (the output is squall-core/target/squall-dependencies-0.2.0.jar).

4. Installation is now completed. The following commands run Squall (the only argument is the path to a Squall configuration file):

   cd bin
   ./squall_local.sh ../test/squall/confs/local/0_01G_hyracks_ncl

If everything is set up correctly, you will get something like this:

All the tasks of the last component in total received 15000 tuples.
FURNITURE = 3007 
AUTOMOBILE = 2979 
MACHINERY = 2536 
BUILDING = 3706 
HOUSEHOLD = 2772

The script also checks the results (the expected results are provided in test/results directory), and the last line of the output should be something like:

OK: Expected result achieved for username_0_01G_hyracks_ncl.

If everything worked fine, you are ready to go! You will find further documentation in the rest of the wiki. If this doesn't work, check the troubleshooting section or open an issue. The instructions for running Squall from an IDE are here. If you want to recompile the code, please consult Recompilation.

We also provide DBToaster local join operator, which is incompatible with the Apache license, so we put it in a separate repo.

In order to run Squall with a different query and/or different database size, please consult Squall Local Configs. Other pre-bundled local SQL configurations are available here. SQL example queries over TPC-H schema are available in the test/squall/sql_queries directory, including Q3, Q5, Q7, Q8, Q9 and Q10 as well as the Hyracks query (a query over the TPC-H schema from [1]). The schema is specified as a txt file in test/squall/schemas/tpch.txt. A user can also easily provide its own schema. Before writing your own queries, please consult Supported features.

References

[1] V. R. Borkar, M. J. Carey, R. Grover, N. Onose, and R. Vernica, “Hyracks: A flexible and extensible foundation for data-intensive computing”, ICDE 2011.