Difference between revisions of "Command-Line Client"

From BaseX Documentation
Jump to navigation Jump to search
(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...")
 
 
(97 intermediate revisions by 4 users not shown)
Line 1: Line 1:
−
<p>BaseX offers a standalone console mode in which all [[Commands]]  
+
This page is part of the [[Getting Started]] Section. It introduces you to the standalone command-line mode of BaseX.
−
and XQuery queries can be executed.</p>
 
  
−
==Run the console version==
+
=Startup=
−
<code>java -cp BaseX*.jar org.basex.BaseX</code>
 
  
−
==First Steps==
+
The command-line client can be started as follows:
−
#Start a console and run BaseX.
 
−
#Have a look at the different commands with 'help'.
 
−
#Create a database with your xml file(s).
 
−
#Run your query and receive the results.
 
−
 
−
==Start of BaseX in console mode==
 
−
 
−
<p>
 
−
Just enter: <code>java -cp BaseX.jar org.base.BaseX</code> on the command line.<br/>
 
−
The Java option <code>-Xmx...</code> reserves more memory, and the <code>-h</code> flag of BaseX lists all available flags:
 
−
</p>
 
−
 
−
<pre>
 
−
java -Xmx512m -cp BaseX.jar org.basex.BaseX -h
 
  
−
Usage: BaseX [-diosuvVwz] [-cq] [file]
+
* Run one of the {{Code|basex}} or {{Code|basex.bat}} scripts.
−
  [file]    Execute XQuery file
+
* If you have installed BaseX on ''Windows'', click on the '''BaseX Standalone''' icon.
−
  -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
 
−
</pre>
 
  
−
==Working with the BaseX Console==
+
All operations will be performed with admin permissions (no password needs to be supplied). Various [[Command-Line_Options#Standalone|command-line options]] are available to simplify batch processing. The [[Start_Scripts|start script]] can be adjusted for individual purposes (e.g. if the default memory limit is too restrictive).
−
 
−
<p>After starting the BaseX Console you can type in <code>help</code> to get a list of all
 
−
[[Commands|BaseX commands]]. Several commands can be separated by semicolons.</p>
 
−
 
−
<p>
 
−
To evaluate commands without entering the console mode, you can use the
 
−
<code>-c</code> option on the command line:
 
−
</p>
 
−
 
−
<pre>
 
−
java -cp BaseX.jar org.basex.BaseX -Vc "create db input input.xml; xquery /"
 
  
−
Database 'input' created in 53.64 ms.
+
The standalone client must not be used if you perform parallel (concurrent) read and write operations on your databases. See [[Startup#Concurrent Operations|Concurrent Operations]] for more details.
−
<html>
 
−
  <!-- Header -->
 
−
  <head id="0">
 
−
    <title>XML</title>
 
−
  </head>
 
−
  <!-- Body -->
 
−
  <body id="1" bgcolor="#FFFFFF" text="#000000" link="#0000CC">
 
−
    <h1>Databases &amp; XML</h1>
 
−
    <div align="right">
 
−
      <b>Assignments</b>
 
−
      <ul>
 
−
        <li>Exercise 1</li>
 
−
        <li>Exercise 2</li>
 
−
      </ul>
 
−
    </div>
 
−
  </body>
 
−
  <?pi bogus?>
 
−
</html>
 
  
−
Query: /
+
=Operations=
  
−
Compiling:
+
==Create a Database==
  
−
Result: root()
+
To create a database, you need an XML document, e.g., [https://files.basex.org/xml/factbook.xml factbook.xml]. Save this document to your working directory and type in the following command to create and open the database:
 +
<code>
 +
> {{Command|CREATE DB}} factbook factbook.xml
 +
</code>
  
−
Parsing: 0.19 ms
+
: '''factbook''' is the name of the database <br/>
−
Compiling: 9.27 ms
+
: '''factbook.xml''' is the initial input of the database<br/>
−
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.
+
By default, databases are stored in the <code>basex/data</code> directory of your project’s home directory. Depending on your [[Configuration]], the location may vary.
−
</pre>
 
  
−
==See also ==
+
==Execute a Query==
−
[[BaseX GUI]]
+
 
 +
The {{Commands|XQUERY}} command lets you run a query. The following query returns all country elements of the currently opened database:
 +
 
 +
<code>
 +
> {{Command|XQUERY}} //country
 +
</code>
 +
 
 +
You can also run queries in files:
 +
 
 +
<code>
 +
> {{Command|RUN}} /path/to/query.xq
 +
</code>
 +
 
 +
==Database Commands==
 +
 
 +
The following command lists all databases that can be opened by the currently logged-in user:
 +
 
 +
<code>
 +
> {{Command|LIST}}
 +
</code>
 +
 
 +
To open an existing database, execute the following:
 +
 
 +
<code>
 +
> {{Command|OPEN}} factbook
 +
</code>
 +
 
 +
To get information on the currently opened database, type:
 +
 
 +
<code>
 +
> {{Command|INFO}}
 +
</code>
 +
 
 +
You can also address a database within your query with the {{Function|Database|db:get}} function:
 +
 
 +
<code>
 +
> {{Command|XQUERY}} db:get("factbook")//country
 +
</code>
 +
 
 +
To close the current database, please type:
 +
 
 +
<code>
 +
> {{Command|CLOSE}}
 +
</code>
 +
 
 +
A database can eventually be dropped again:
 +
 
 +
<code>
 +
> {{Command|DROP DB}} factbook
 +
</code>
 +
 
 +
==Multiple Resources==
 +
 
 +
One database can contain not only a single, but millions of documents. All documents can have a different structure.
 +
 
 +
With the following commands, you can create an empty database and add two documents. It is also possible to address resources via URLs:
 +
 
 +
<code>
 +
> {{Command|CREATE DB}} store
 +
</code><br/>
 +
<code>
 +
> {{Command|ADD}} factbook.xml
 +
</code><br/>
 +
<code>
 +
> {{Command|ADD}} http://files.basex.org/xml/xmark.xml
 +
</code>
 +
 
 +
Deleting a document from a database is easy, but make sure that the database, which contains the addressed document, is currently opened:
 +
 
 +
<code>
 +
> {{Command|DELETE}} factbook.xml
 +
</code>
 +
 
 +
==Backup and Restore==
 +
 
 +
To back up and restore your database, type:
 +
 
 +
<code>
 +
> {{Command|CREATE BACKUP}} factbook
 +
</code><br/>
 +
<code>
 +
> {{Command|RESTORE}} factbook
 +
</code>
 +
 
 +
The backup file is stored in the database directory. It contains the name of the database and a timestamp: <code>[db-name]-[timestamp].zip</code>. If a database is to be restored, and if several backups exist, the backup with the newest timestamp is taken.

Latest revision as of 16:20, 25 July 2022

This page is part of the Getting Started Section. It introduces you to the standalone command-line mode of BaseX.

Startup[edit]

The command-line client can be started as follows:

  • Run one of the basex or basex.bat scripts.
  • If you have installed BaseX on Windows, click on the BaseX Standalone icon.

All operations will be performed with admin permissions (no password needs to be supplied). Various command-line options are available to simplify batch processing. The start script can be adjusted for individual purposes (e.g. if the default memory limit is too restrictive).

The standalone client must not be used if you perform parallel (concurrent) read and write operations on your databases. See Concurrent Operations for more details.

Operations[edit]

Create a Database[edit]

To create a database, you need an XML document, e.g., factbook.xml. Save this document to your working directory and type in the following command to create and open the database: > CREATE DB factbook factbook.xml

factbook is the name of the database
factbook.xml is the initial input of the database

By default, databases are stored in the basex/data directory of your project’s home directory. Depending on your Configuration, the location may vary.

Execute a Query[edit]

The Template:Commands command lets you run a query. The following query returns all country elements of the currently opened database:

> XQUERY //country

You can also run queries in files:

> RUN /path/to/query.xq

Database Commands[edit]

The following command lists all databases that can be opened by the currently logged-in user:

> LIST

To open an existing database, execute the following:

> OPEN factbook

To get information on the currently opened database, type:

> INFO

You can also address a database within your query with the db:get function:

> XQUERY db:get("factbook")//country

To close the current database, please type:

> CLOSE

A database can eventually be dropped again:

> DROP DB factbook

Multiple Resources[edit]

One database can contain not only a single, but millions of documents. All documents can have a different structure.

With the following commands, you can create an empty database and add two documents. It is also possible to address resources via URLs:

> CREATE DB store
> ADD factbook.xml
> ADD http://files.basex.org/xml/xmark.xml

Deleting a document from a database is easy, but make sure that the database, which contains the addressed document, is currently opened:

> DELETE factbook.xml

Backup and Restore[edit]

To back up and restore your database, type:

> CREATE BACKUP factbook
> RESTORE factbook

The backup file is stored in the database directory. It contains the name of the database and a timestamp: [db-name]-[timestamp].zip. If a database is to be restored, and if several backups exist, the backup with the newest timestamp is taken.

Retrieved from "http://docs.basex.org/index.php?title=Command-Line_Client&oldid=16182"