ARQ
===
A query processor for Jena.

    andy.seaborne@hp.com

This is experimental - there is no support.

Releases       http://jena.hpl.hp.com/~afs/BRQL/

Names
-----

RDQL    - the original query language from Jena 1.2
BRQL    - an upwards compatible RDQL with a few DAWG-like extensions
SPARQL  - the DAWG query language and protocol
ARQ     - The new query engine and the name of its native query language

Installation
------------

Unpack zip : it unpacks into a directory.
Set environment variable ARQROOT to the path of this direrctory.

There are some scripts in <download>/bin/ - ensure they are executable and
in UNIX line-end format (zipping on Windows does not make this automatic).
These scripts are bash scripts and they do run under Cygwin.  There are no
.bat versions yet.

Running from the command line
-----------------------------

First, ensure scripts are executable (if they were packed under Windows,
the x flag may not be preserved)

chmod u+x $ARQROOT/bin/*

Commnad line applications:
sparql   -- Run a SPARQL query.  A wrapper around 'query'.
arq      -- Run an ARQ query.  A wrapper around 'query'.
query    -- Run a query. 
qparse   -- Parse a query
qtest    -- Run tests

For the 'query' command, files ending .rq are assumed to be SPARQL queries
and files ending .arq are ARQ queries, unless the syntax is given
explicitly.  Unknown files are assumed to be SPARQL queries.

sparql --data <some data file> --query query 
sparql --data <some data file> 'Query string'

Default output is a text table for SELECT queries, an RDF model for
DESCRIBE and CONSTRUCT.

Run the script with no argument to get a usage message.

Running as Java
---------------

Put all the jars files in lib/ on your classpath.  All of them, including
the version of jena.jar.

The arq command line application is:
java -cp ..classpath.. brql.query "$@"

Running the test suite:
java -cp ...  junit.textui.TestRunner com.hp.hpl.jena.brql.test.BRQLTestSuite

Documentation
-------------

See doc/javadoc/index.html but this is rather minimal.  Don't reply on the
javaodoc comments in the code being in step with the running code.

Misc
----

ARQ has been run under ikvm (http://www.ikvm.net/) after some changes (to
BRQL and to Jena) to avoid little things in ikvm that are in progress (full
UTF-8 and security) in ikvm or its needed subsystems.


Changes
-------

See ChangeLog.txt

Integration with XML
--------------------

Results out for SELECT queries in XML is supported.  This can be
transformed using XSLT or XQuery.  A few examples in xml/