Command-Line Client

From BaseX Documentation
Revision as of 18:57, 27 December 2010 by AW (talk | contribs) (Created page with "<p>BaseX offers a standalone console mode in which all Commands and XQuery queries can be executed.</p> ==Run the console version== <code>java -cp BaseX*.jar org.basex.Base...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

BaseX offers a standalone console mode in which all Commands and XQuery queries can be executed.

Run the console version

java -cp BaseX*.jar org.basex.BaseX

First Steps

  1. Start a console and run BaseX.
  2. Have a look at the different commands with 'help'.
  3. Create a database with your xml file(s).
  4. Run your query and receive the results.

Start of BaseX in console mode

Just enter: java -cp BaseX.jar org.base.BaseX on the command line.
The Java option -Xmx... reserves more memory, and the -h flag of BaseX lists all available flags:

java -Xmx512m -cp BaseX.jar org.basex.BaseX -h

Usage: BaseX [-diosuvVwz] [-cq] [file]
  [file]     Execute XQuery file
  -c<cmd>    Execute database command(s)
  -d         Activate debugging mode
  -i<input>  Open initial file or database
  -o<file>   Write output to file
  -q<expr>   Execute XQuery expression
  -s<pars>   Set serialization parameter(s)
  -u         Write updates back to original files
  -v/V       Show (all) process info
  -w         Keep whitespaces from source files
  -z         Skip output of results

Working with the BaseX Console

After starting the BaseX Console you can type in help to get a list of all BaseX commands. Several commands can be separated by semicolons.

To evaluate commands without entering the console mode, you can use the -c option on the command line:

java -cp BaseX.jar org.basex.BaseX -Vc "create db input input.xml; xquery /"

Database 'input' created in 53.64 ms.
  <!-- Header -->
  <head id="0">
  <!-- Body -->
  <body id="1" bgcolor="#FFFFFF" text="#000000" link="#0000CC">
    <h1>Databases & XML</h1>
    <div align="right">
        <li>Exercise 1</li>
        <li>Exercise 2</li>
  <?pi bogus?>

Query: /


Result: root()

Parsing: 0.19 ms
Compiling: 9.27 ms
Evaluating: 0.33 ms
Printing: 3.08 ms
Total Time: 12.88 ms
Results: 1 Item
Updated: 0 Items
Printed: 375 Bytes
Memory: 5834 KB

Query executed in 13.25 ms.

See also