Difference between revisions of "Command-Line Client"

From BaseX Documentation
Jump to navigation Jump to search
m (Text replace - "[[Startup Options" to "[[Command-Line Options")
m (Text replacement - "[http://files.basex.org/" to "[https://files.basex.org/")
 
(44 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
This page is part of the [[Getting Started]] Section.
 
This page is part of the [[Getting Started]] Section.
BaseX offers a standalone (embedded) console mode from which all [[Commands|database commands]] can be executed.
+
It introduces you to the standalone command-line mode of BaseX.
The article on the [[Database Server]] provides numerous examples for running commands in the console mode
 
(note that the GUI does ''not'' interact with the client/server architecture).
 
  
==Startup==
+
=Startup=
First of all, please launch a '''standalone''' version of BaseX: double click on the '''BaseX''' icon, or run the <code>basex</code> script. [[Startup#BaseX Standalone|Follow this link]] for more information (or check out the additional [[Command-Line Options#BaseX Standalone|command-line options]]).
 
  
==Working with the BaseX Console==
+
The command-line client can be started as follows:
 
After the BaseX Console has been started, the <code>HELP</code> command can be used to
 
to list all [[Commands|database commands]]. Multiple commands can be separated by semicolons.
 
  
To evaluate commands without entering the console mode, you can use the
+
* Run one of the {{Code|basex}} or {{Code|basex.bat}} scripts.
<code>-c</code> option on the command line:
+
* If you have installed BaseX on ''Windows'', click on the '''BaseX Standalone''' icon.
 
<pre>
 
basex -Vc "CREATE DB input <example/>; XQUERY /"
 
  
Database 'input' created in 124.95 ms.
+
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).
<example/>
 
  
Query: /
+
Please note that 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.
  
Compiling:
+
=Operations=
  
Result: root()
+
==Create a Database==
  
Parsing: 0.42 ms
+
* To create a database you need an XML document, e.g. [https://files.basex.org/xml/factbook.xml factbook.xml].
Compiling: 9.3 ms
+
* Save this document to your working directory.
Evaluating: 0.35 ms
+
* Type in the following command to create and open the database:
Printing: 5.53 ms
+
<code>
Total Time: 15.62 ms
+
> [[Commands#CREATE DB|CREATE DB]] factbook factbook.xml
 +
</code>
  
Hit(s): 1 Item
+
: '''factbook''' is the name of the database <br/>
Updated: 0 Items
+
: '''factbook.xml''' is the initial input of the database<br/>
Printed: 10 Bytes
 
  
Query executed in 15.62 ms.
+
; Where is the database stored?
</pre>
 
  
All available command-line options can be found [[Command-Line Options#BaseX Standalone|here]].
+
By default, databases are stored in the <code>basex/data</code> directory, which is located in your home folder.
 +
Depending on your [[Configuration]], the location of your home folder varies. For example, on a Mac it's <code>/Users/John</code>, if your name is John.
  
==See also ==
+
==Execute a Query==
[[GUI]], [[Database Server]], [[Getting Started]]
+
 
[[Category:Beginner]]
+
The [[Commands#XQUERY|XQUERY]] command lets you run a query.
 +
* For example, the following query returns all country nodes in the currently opened factbook database.
 +
<code>
 +
> [[Commands#XQUERY|XQUERY]] //country
 +
</code>
 +
 
 +
* You can also run queries in files:
 +
<code>
 +
> [[Commands#RUN|RUN]] /Users/John/query.xq
 +
</code>
 +
 
 +
==Database Commands==
 +
 
 +
* The following command lists all databases than can be opened by the currently logged in user:
 +
<code>
 +
> [[Commands#LIST|LIST]]
 +
</code>
 +
 
 +
* To open an existing database, execute the following:
 +
<code>
 +
> [[Commands#OPEN|OPEN]] factbook
 +
</code>
 +
 
 +
* To get information on the currently opened database, type:
 +
<code>
 +
> [[Commands#INFO|INFO]]
 +
</code>
 +
 
 +
* You can also address a database within your query with the [[Database Module#db:open|db:open]] function:
 +
<code>
 +
> [[Commands#XQUERY|XQUERY]] db:open("factbook")//country
 +
</code>
 +
 
 +
* To [[Commands|close]] the current database, please type:
 +
<code>
 +
> [[Commands#CLOSE|CLOSE]]
 +
</code>
 +
 
 +
* Use the [[Commands#DROP DB|DROP DB]] command to delete a database:
 +
<code>
 +
> [[Commands#DROP DB|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>
 +
> [[Commands#CREATE DB|CREATE DB]] store
 +
</code><br/>
 +
<code>
 +
> [[Commands#ADD|ADD]] factbook.xml
 +
</code><br/>
 +
<code>
 +
> [[Commands#ADD|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>
 +
> [[Commands#DELETE|DELETE]] factbook.xml
 +
</code>
 +
 
 +
==Backup and Restore==
 +
 
 +
* To backup your database, type:
 +
<code>
 +
> [[Commands#CREATE BACKUP|CREATE BACKUP]] factbook
 +
</code>
 +
 
 +
* To restore your database, type:
 +
<code>
 +
> [[Commands#RESTORE|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 12:46, 2 July 2020

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.

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).

Please note that 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.
  • 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
Where is the database stored?

By default, databases are stored in the basex/data directory, which is located in your home folder. Depending on your Configuration, the location of your home folder varies. For example, on a Mac it's /Users/John, if your name is John.

Execute a Query[edit]

The XQUERY command lets you run a query.

  • For example, the following query returns all country nodes in the currently opened factbook database.

> XQUERY //country

  • You can also run queries in files:

> RUN /Users/John/query.xq

Database Commands[edit]

  • The following command lists all databases than 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:open function:

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

  • To close the current database, please type:

> CLOSE

  • Use the DROP DB command to delete a database:

> 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 backup your database, type:

> CREATE BACKUP factbook

  • To restore your database, type:

> 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.