Installation

• Install Classic Eclipse

  Follow the instruction for eclipse on from www.eclipse.org for the "Classic" eclipse version.

• Install Maven Integration (m2e)

  VXQuery uses Maven to define external libraries and build instructions. The Eclipse plugin for Maven integeration can be found at m2e.

Code Formatter Setup

For VXQuery, the Hyracks project Eclipse formating template has been adopted as the standard. The template file can be found at http://hyracks.googlecode.com/files/HyracksCodeFormatProfile.xml

Menu Options from Preferences:

• Java
  • Code Style
    • Formatter

Code Import Setup

1. Import Hyracks Code Base

   Download and install the Hyracks Full Stack Staging branch to get the latest Hyracks support for development. This is required since some new features being build are affecting Hyracks development.

   $ svn checkout https://hyracks.googlecode.com/svn/branches/fullstack_staging hyracks_for_vxquery
   (Accept the certificate information for *.googlecode.com.)
   $ cd hyracks_for_vxquery
   $ mvn install -DskipTests
   $ cd ..

   Finally, from Eclipse's File menu "import" the Maven Hyracks project you have just downloaded through SVN.

2. Import VXQuery Code Base

   The VXQuery code base must be installed so eclipse has full access. Similar to the Hyracks installation, VXQuery needs to be downloaded from Apache's SVN repository.

   $ svn checkout https://svn.apache.org/repos/asf/incubator/vxquery/trunk/ apache_vxquery_incubating
   (Accept the certificate information for *.apache.org.)
   $ cd apache_vxquery_incubating/vxquery
   $ mvn package -DskipTests
   $ cd ../..

   Finally, from Eclipse's File menu "import" the Maven VXQuery project you have just downloaded through SVN.

3. Additional Project Configuration

   Some eclipse build errors will show up. To remove these display errors, add "target/generated-sources/javacc" as a source folder in VXQuery Core.

Debugging

Eclipse can be used to debug VXQuery. Using the following java option will allow eclipse to pause the execution and allow eclipse to step through the code.

"-Xdebug -Xrunjdwp:transport=dt_socket,address=127.0.0.1:8000,server=y,suspend=y"

Realize you may need to update the address for your system. More details can be found at IBM

JAVA_OPTS="-Xmx1024m -Xdebug -Xrunjdwp:transport=dt_socket,address=127.0.0.1:8000,server=y,suspend=y" sh vxquery-cli/target/appassembler/bin/vxq ../test.xq -showoet