Apache VXQuery
--------------


Requirements:

1. JDK >= 1.6
2. Apache Maven >= 2.0


Building:

1. Type "mvn test" in the vxquery base folder.


Running:

There are two ways to run VXQuery:
Note: shell scripts exist for running VXQuery for Un*x like systems.
TODO: Add Windows batch files

1. Command line client (vxq)

Type target/scripts/vxq without any arguments for help on executing the command line client.


2. XQTS test driver (xtest)

The xtest test driver can be used to execute XQuery tests from the XQTS suite.

Type target/scripts/xtest without any arguments for help on executing xtest.

Note: XQTS test suite needs to be obtained through CVS
Do NOT use the XQTS zip files available from the XQTS web site. They are too old.

There are 2 way to get a current version of the files:

a) via regular CVS

Assume you are in $XQTS_HOME (location where you want to checkout XQTS).

$ export CVSROOT=":pserver:anonymous@dev.w3.org:/sources/public"
$ cvs login
(Logging in to anonymous@dev.w3.org)
CVS password: anonymous
$ cvs get 2006/xquery-test-suite/TestSuiteStagingArea
    ...

Once the testsuite is checked out locally, xtest should be passed the -xqtsbase argument with the absolute path to the folder that contains XQTSCatalog.xml

$ cd $VXQUERY_HOME
$ target/scripts/xtest -xqtsbase $XQTS_HOME/2006/xquery-test-suite/TestSuiteStagingArea ...

b) via CVS web access

Version history:
http://dev.w3.org/cvsweb/2006/xquery-test-suite/PublicPagesStagingArea/XQTS_current.zip
Latest Version:
http://dev.w3.org/cvsweb/~checkout~/2006/xquery-test-suite/PublicPagesStagingArea/XQTS_current.zip 

Eclipse "integration":

The eclipse files in the project rely on the availability of the classpath variable M2_REPO that needs to point to the local maven repository.
M2_REPO can be added to the eclipse workspace using the maven-eclispe-plugin:

$ mvn -Declipse.workspace=<path-to-eclipse-workspace> eclipse:add-maven-repo