Difference between revisions of "Command-Line Client"

From BaseX Documentation
Jump to navigation Jump to search
 
(22 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. It introduces you to the standalone command-line mode of BaseX.
BaseX offers a standalone console mode from which all [[Commands|database commands]] can be executed.
 
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#Standalone|Follow this link]] for more information (or check out the additional [[Command-Line Options#Standalone|command-line options]]).
+
The command-line client can be started as follows:
  
=Create a Database=
+
* Run one of the {{Code|basex}} or {{Code|basex.bat}} scripts.
 +
* If you have installed BaseX on ''Windows'', click on the '''BaseX Standalone''' icon.
  
* To create a database you need an XML document, e.g. [http://files.basex.org/xml/factbook.xml factbook.xml].
+
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).
* Save this document to your working directory.
+
 
* Type in the following command to create and open the database:
+
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.
 +
 
 +
=Operations=
 +
 
 +
==Create a Database==
 +
 
 +
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>
 
<code>
> [[Commands#CREATE DB|CREATE DB]] factbook factbook.xml
+
> {{Command|CREATE DB}} factbook factbook.xml
 
</code>
 
</code>
  
Line 20: Line 24:
 
: '''factbook.xml''' is the initial input of the database<br/>
 
: '''factbook.xml''' is the initial input of the database<br/>
  
; Where is the database stored?
+
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.
  
By default, databases are stored in the <code>basex/data</code> directory, which is located in your home folder.
+
==Execute a Query==
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.
 
  
=Execute a Query=
+
The {{Commands|XQUERY}} command lets you run a query. The following query returns all country elements of the currently opened database:
  
The [[Commands#XQUERY|XQUERY]] command lets you run a query.
 
* For example, this query returns all country nodes in the currently opened database.
 
 
<code>
 
<code>
> [[Commands#XQUERY|XQUERY]] //country
+
> {{Command|XQUERY}} //country
 
</code>
 
</code>
  
* You can also run queries in files:
+
You can also run queries in files:
 +
 
 
<code>
 
<code>
> [[Commands#RUN|RUN]] /Users/John/query.xq
+
> {{Command|RUN}} /path/to/query.xq
 
</code>
 
</code>
  
=Database Commands=
+
==Database Commands==
 +
 
 +
The following command lists all databases that can be opened by the currently logged-in user:
  
* The following command lists all databases than can be opened by the currently logged in user:
 
 
<code>
 
<code>
> [[Commands#LIST|LIST]]
+
> {{Command|LIST}}
 
</code>
 
</code>
  
* To open an existing database, execute the following:
+
To open an existing database, execute the following:
 +
 
 
<code>
 
<code>
> [[Commands#OPEN|OPEN]] factbook
+
> {{Command|OPEN}} factbook
 
</code>
 
</code>
  
* To get information on the currently opened database, type:
+
To get information on the currently opened database, type:
 +
 
 
<code>
 
<code>
> [[Commands#INFO|INFO]]
+
> {{Command|INFO}}
 
</code>
 
</code>
  
* You can also address a database within your query with the [[Database Module#db:open|db:open]] function:
+
You can also address a database within your query with the {{Function|Database|db:get}} function:
 +
 
 
<code>
 
<code>
> [[Commands#XQUERY|XQUERY]] db:open("factbook")//country
+
> {{Command|XQUERY}} db:get("factbook")//country
 
</code>
 
</code>
  
* To [[Commands|close]] the current database, please type:  
+
To close the current database, please type:  
 +
 
 
<code>
 
<code>
> [[Commands#CLOSE|CLOSE]]
+
> {{Command|CLOSE}}
 
</code>
 
</code>
  
* Use the [[Commands#DROP DB|DROP DB]] command to delete a database:
+
A database can eventually be dropped again:
 +
 
 
<code>
 
<code>
> [[Commands#DROP DB|DROP DB]] factbook
+
> {{Command|DROP DB}} factbook
 
</code>
 
</code>
  
=Multiple Resources=
+
==Multiple Resources==
  
 
One database can contain not only a single, but millions of documents. All documents can have a different structure.
 
One database can contain not only a single, but millions of documents. All documents can have a different structure.
Line 77: Line 85:
  
 
<code>
 
<code>
> [[Commands#CREATE DB|CREATE DB]] store<br/>
+
> {{Command|CREATE DB}} store
> [[Commands#ADD|ADD]] factbook.xml<br/>
+
</code><br/>
> [[Commands#ADD|ADD]] http://files.basex.org/xml/xmark.xml
+
<code>
 +
> {{Command|ADD}} factbook.xml
 +
</code><br/>
 +
<code>
 +
> {{Command|ADD}} http://files.basex.org/xml/xmark.xml
 
</code>
 
</code>
  
* Deleting a document from a database is easy:
+
Deleting a document from a database is easy, but make sure that the database, which contains the addressed document, is currently opened:
 +
 
 
<code>
 
<code>
> [[Commands#DELETE|DELETE]] factbook.xml
+
> {{Command|DELETE}} factbook.xml
 
</code>
 
</code>
  
Make sure that the database, which contains the addressed document, is currently opened.
+
==Backup and Restore==
  
=Backup and Restore=
+
To back up and restore your database, type:
  
* To backup your database, type:
 
 
<code>
 
<code>
> [[Commands#CREATE BACKUP|CREATE BACKUP]] factbook
+
> {{Command|CREATE BACKUP}} factbook
</code>
+
</code><br/>
 
 
* To restore your database, type:
 
 
<code>
 
<code>
> [[Commands#RESTORE|RESTORE]] factbook
+
> {{Command|RESTORE}} factbook
 
</code>
 
</code>
  
The backup file is stored in the database directory.
+
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.
The contains the name of the database and a timestamp: <code>[db-name]-[timestamp].zip</code>.
 
If a database is restored, and if several backups exist, the backup with the newest timestamp is taken.
 

Latest revision as of 15: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.