Mulgara

= Deployment =
When building Mulgara for deployment you have to select one or more build targets. This page describes the various targets, and what the resulting artifacts are used for.

The standard target is simply ''dist'' which builds all the major deployment targets.

Targets
The artifacts created by each of the deployment targets are:
'''dist::
All other distribution targets.
'''embedded-dist'''::
Creates mulgara-''version''.jar
'''querylang-dist'''::
Creates querylang-''version''.jar
'''driver-dist'''::
Creates driver-''version''.jar
'''descriptor-dist'''::
Creates descriptor-''version''.jar
'''mulgara-war'''::
Creates mulgara-''version''.war
'''lite-dist'''::
Creates mulgara-lite-''version''.jar
'''raw-dist'''::
Creates mulgara-raw-''version''.jar
'''core-dist'''::
Creates mulgara-core-''version''.jar JARs
The selection of which Jar to use is dependent on the deployment environment. The following is a description of each Jar.

=== mulgara-''version''.jar ===
This is the general server jar. This contains the complete Mulgara system, and includes all the 3rd party libraries that Mulgara relies on. The Jar is executable, so it can be started easily with: {{{
#!sh
java -jar mulgara-x.y.z.jar
}}}
No classpath is necessary to execute this jar, since everything is included.

If the built-in configuration is used, then Mulgara will create a database on disk, start an HTTP server with various web services, and an RMI server for Java connections. The default database will support all of the default resolvers and content handlers.

A different configuration can be set up at compile time (by editing the [http://mulgara.org/svn/mulgara/trunk/conf/mulgara-config.xml conf/mulgara-config.xml] file), or at runtime by using the '''-c''' command-line option. Note that the '''-c''' option is used to point to a URL, and not a file. So an example of using this might be: {{{
#!sh
java -jar mulgara-x.y.z.jar -c "file:/home/user/mulgara-config.xml"
}}}
Use the '''-h''' option for a full set of command line options for the server program.

While useful, this jar is not suitable for use in an existing environment like Tomcat, due to the potential conflict between the environment path and the 3rd party jars that have been built in.

=== querylang-''version''.jar ===
The is the general client jar. This contains everything needed to connect to a server, including a console application for issuing commands. Like ''mulgara-version.jar'' this jar includes all the 3rd party libraries it needs, though this is significantly less.

The console application can be started in one of two modes. The default is a GUI console: {{{
#!sh
java -jar querylang-x.y.z.jar
}}}
This brings up a Swing window containing a "command shell", useful for typing TQL commands, complete with command line editing and shell history. Java does not provide terminal controls by default, which made it impossible to develop this for use on the command line. However, new multi-platform libraries are making this feasible, and consequently we expect to deprecate this Swing version soon.

It is also possible to run the client without a window, on a batch script. This uses the '''-s''' switch, and must specify a URL for the script. An example of running a script in a local file is: {{{
#!sh
java -jar querylang-x.y.z.jar -s "file:/home/user/data/myscript.tql"
}}}
Use the '''-h''' option for a full set of command line options for this client. Also consider using the tools found in the "'''tools'''" directory of the sources. While these were built to demonstrate the use of the various APIs, they are often more useful than the complete client application. There are two applications here: '''org.mulgara.tools.Tql''' and '''org.mulgara.tools.Sparql'''. See the associated [http://mulgara.org/svn/mulgara/trunk/tools/README.txt README.txt] file for building and using these.

Like ''mulgara-version.jar'', this jar contains more than is desirable for some environments.

''to be continued...''