FarragoEclipse

Farrago Development

Instructions for setting up Eclipse for use in Farrago development:

1. Get an ant-only build of Farrago working
2. Download and unpack a copy of Eclipse SDK 3.1
3. From Farrago, run ant createEclipseProject; this will generate .project and .classpath files with the correct thirdparty dependencies predefined.
4. Start Eclipse
5. Accept the default workspace location (or customize your own), and check the box to make it the default
6. Choose Workbench
7. From the top menu, choose File->New->Project
   1. Choose the Java Project wizard (but not from Existing Ant Buildfile)
   2. Enter farrago for the project name
   3. Change Contents to Create project from existing source
   4. Enter the path to farrago (e.g. /home/calvin/open/farrago)
   5. Click the Finish button
8. From the top menu, choose Project->Properties
   1. Open the Java Code Style tree node and select Formatter
      1. Click the Enable project specific settings checkbox
      2. Click the Import button
      3. Browse to and select farrago/eclipse/codeFormat.xml
   2. Select Organize Imports in the tree
      1. For the Number of imports needed for .*, change the value to 0 to force imports to get collapsed
   3. Click the Apply button and then Yes to rebuild the project; you may get a lot of warnings, but there should be no errors
   4. Click OK
9. You should now be able to browse source files, build, run JUnit tests, etc.
10. Install the Perforce plugin
11. From the Package Explorer, right-click the farrago project to get a pop-up menu
    1. Choose Team->Share Project
    2. Select Perforce for repository type and click Next
    3. Enter connection information for your client and click Finish

Note that whenever the thirdparty classpath defined in the ant build changes, you will need to rerun ant createEclipseProject to propagate the changes. No other action should be required.

Farrago Server Debugging

For ad-hoc SQL debugging, here's the procedure:

1. Browse to class net.sf.farrago.test.FarragoDebugServer
2. Debug the main method as a Java Application
3. You will see the Farrago server startup messages in the console at the bottom
4. Run a client such as the sqllineClient script to connect to the server
5. Set breakpoints, debug, etc.
6. When you are done, after disconnecting the client, go back to the Eclipse console window and enter the !quit command to shut down the server cleanly (yes, you can type stuff in that window!)

There are two errors you might encounter if you get a problem trying to load the database. The first is: "Installation error: required Java property java.util.logging.config.file not set". The second error is: "java.lang.UnsatisfiedLinkError: no farrago in java.library.path".

To fix the first error, open the Debug Configurations window within the Debug As context menu, and click the Arguments tab. Put in "-Dnet.sf.farrago.home=. -Djava.util.logging.config.file=trace/FarragoTrace.properties" under the VM Arguments option. These are normally passed with the farragoServer script so you need to include them manually for Eclipse.

To fix the second error, open the Debug Configurations window again and open the Environment tab. Add a new variable called LD_LIBRARY_PATH and set its value to be "/path/to/dev/fennel/farrago". There is a .so file (.dll for Windows) that needs to be loaded and that particular path is usually set by the user from sourcing the contents of fennelenv.sh.

LucidDB Debugging

If you want to debug the LucidDB server or tests, you can follow steps similar to the ones above for Farrago.

1. Start with ant createEclipseProject from the luciddb directory, register the project, etc.
2. Select the new luciddb project, configure its Build Path, and click Link Source from the Source tab.
3. Enter the location of farrago/src.
4. You'll need to give it an alias such as farrago_src to avoid clashing with luciddb/src.
5. Click Finish to save the path.

To debug the server:

1. Browse to class com.lucidera.luciddb.test.LucidDbDebugServer and debug it (as above for FarragoDebugServer).

WARNING: building the luciddb project will create duplicate class copies of farrago, which is not what you want unless you want mysterious runtime errors after making changes.

Debugging Via sqllineEngine

Here's an alternate way to debug, using sqllineEngine:

1. From a shell prompt, run sqllineEngine using sh -x sqllineEngine. This will allow you to see the full java command required to run sqllineEngine. The last line of trace should be formatted as java [vm_args...] [java class] [program arguments...]
2. In Eclipse, from the Run menu, select Debug.... This brings up a window for editing debug configurations.
3. In the left tree pane, select Java Application and hit the button underneath the pane for New debug configuration.
4. In the right window pane, under the Main tab, enter sqlline.SqlLine as your Main class
5. Select the Arguments tab
6. Copy and paste the Program and VM (java virtual machine) arguments that were used to run your program (as described above)
7. For working directory, enter the full path to farrago (or luciddb) such as /home/calvin/open/farrago.
8. To run a luciddb version of sqllineEngine, there are two extra steps. Navigate to the Classpath tab. Remove the default classpath (because it will cause Farrago to be loaded). Then, navigate to the Source tab. Click Add on the right hand side. Then, click on Java Project. This will display a list of your current projects. Select the one corresponding to your Farrago project. Then, click OK. This allows Eclipse to find the corresponding Farrago source files when you're debugging LucidDB.
9. Finally, at the bottom right corner of the window, there are buttons to Apply the changes to your configuration, and to Debug using your configuration.