Command-line tool user guideXQuark Fusion 1.1 |
Notice: Use this document if you need to install, configure and run a command-line tool to test or demonstrate XQuark Fusion features.
This document is the XQuark Fusion command-line tool user guide.
XQuark Fusion - Command-line utility
Warning
This tool is mainly provided for demonstration or test purposes since the launching overhead does not allow to reach the performance of a server-side use through the API.
Synopsis
xqfusion [ options ] confFile [queryFile outFile]
- options
- command-line options
- confFile
- file containing the configuration
- queryFile
- file containing an XQuery
- outFile
- file in which the query results are written
Description
The XQuark Fusion tool is used to extract XML data from heterogeneous and distributed databases, using the XQuery language
Configuration
Environment variables
The XQuark Fusion tool uses several environment variable:
- JAVA_HOME: this variable must be set to the directory where the JRE 1.3.1 or 1.4.x can be found. If not set, the script will run the first java executable found on the execution path.
- XQ_CLASSPATH: this variable defines the additional classpath which is appended to the standard one and to the XQuark Fusion distribution jars before running the software. It is used to load the JDBC driver classes and JAXP-compliant parsers that are not part of the delivery (see user documentation for details).
If running under Windows 9x:
- XQFUSION_HOME: this variable must be set to the directory where XQuark Fusion was installed.
Configuration
In order to work, XQuark Fusion needs to be configured using a configuration file. The installation guide describes how to write a simple configuration file.
Tracing
XQFusion uses Apache Log4J for logging . You can configure the trace by modifying the bin/log4j.properties file (refer to Log4J documentation for more details). For instance, to produce debug logs, set the log4j.rootLogger property to DEBUG.
Options
- -?, -help
- Lists the options on the standard output.
- -cp classpath
- A classpath, in the standard pratform-specific format.
- -f file
- A file containing a list of parameters. Each line of the file must contain a query file and an optional output file.
- -debug
- Writes debug information to the standard output.
by XQuark Group