Differences between revisions 3 and 4
Revision 3 as of 2013-09-09 17:45:59
Size: 2894
Revision 4 as of 2013-11-01 13:31:39
Size: 2531
Deletions are marked like this. Additions are marked like this.
Line 3: Line 3:
Download the latest stable MRQL source release from [[http://www.apache.org/dist/incubator/mrql/]] and extract the files. Download the latest stable MRQL source release from [[http://www.apache.org/dyn/closer.cgi/incubator/mrql]] and extract the files.
Line 10: Line 10:
To build MRQL using maven, use {{{mvn package}}}. To validate the installation use {{{mvn verify}}}, To build MRQL using maven, use {{{mvn install}}}. To validate the installation use {{{mvn install -Dtests}}},
Line 13: Line 13:
Alternatively, you may use {{{make}}} or {{{ant}}} to rebuild MRQL. Change the first lines of {{{conf/mrql-env.sh}}} and {{{conf/mrql-ant-env.sh}}} to point to your directories.
{{{make}}} or {{{ant}}} rebuilds the {{{lib/mrql.jar}}}.
{{{make bsp}}} or {{{ant bsp}}} rebuilds the {{{lib/mrql-bsp.jar}}}.
{{{make spark}}} or {{{ant spark}}} rebuilds the {{{lib/mrql-spark.jar}}}.
Line 19: Line 15:

Getting the source code

Download the latest stable MRQL source release from http://www.apache.org/dyn/closer.cgi/incubator/mrql and extract the files. You can get the latest source code using:

git clone https://git-wip-us.apache.org/repos/asf/incubator-mrql.git

To build MRQL using maven, use mvn install. To validate the installation use mvn install -Dtests, which runs the queries in tests/queries in memory, local Hadoop mode, local Hama mode, and Spark standalone mode.

Eclipse Project File Generation

We are using Maven so you can easily generate project files for our modules.

First you should make sure you have set up your workspace correctly with maven:

mvn -Declipse.workspace="/home/user/workspace/" eclipse:configure-workspace

Note: "/home/user/workspace/" should be the path to your workspace.

You can check if it was successful in Eclipse via:

Select Window > Preferences
Select Java > Build Path > Classpath Variables

If you see the M2_REPO variable, it worked correctly.

Now run the following commands:

% mvn clean install

% mvn eclipse:eclipse

You can now import the projects into your eclipse workspace via:

File -> Import -> Existing Projects into Workspace -> Choose your workspace as the root directory and import the mrql-* projects.

On Window/Preferences/General/Editors/File Associations, add *.gen and associate it with the Java Editor.

Making Changes

Before you start, send a message to the MRQL developer mailing list, or file a bug report in Jira. Describe your proposed changes and check that they fit in with what others are doing and have planned for the project. Be patient, it may take folks a while to understand your requirements.

  • Jira usage guidelines

Modify the source code and add some (very) nice features using your favorite IDE.

But take care about the following points

  • All public classes and methods should have informative Javadoc comments.
  • Contributions should pass existing unit tests.
  • New unit tests should be provided to demonstrate bugs and fixes.

Creating a patch

Check to see what files you have modified with:

  % git status

Add any new files with:

  % git add any_files_you_created_modified_or_deleted

In order to create a patch, type

  % git diff --cached > /tmp/MRQL-131.patch

Contributors (last edited 2013-11-01 13:31:39 by LeonidasFegaras)