Difference between revisions of "Command-Line Client"

From BaseX Documentation
Jump to navigation Jump to search
m (Text replacement - "[http://files.basex.org/" to "[https://files.basex.org/")
 
(37 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 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#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].
+
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 the directory you are working in.
+
 
* In the client terminal, type in:
+
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.
 +
 
 +
=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.
 +
* Type in the following command to create and open the database:
 
<code>
 
<code>
 
> [[Commands#CREATE DB|CREATE DB]] factbook factbook.xml
 
> [[Commands#CREATE DB|CREATE DB]] factbook factbook.xml
Line 18: Line 25:
  
 
: '''factbook''' is the name of the database <br/>
 
: '''factbook''' is the name of the database <br/>
: '''factbook.xml''' is the xml file, which is used to create the database<br/>    
+
: '''factbook.xml''' is the initial input of the database<br/>
  
If everything works you see the following lines:
 
<pre>Database 'factbook' created in 950.83 ms.
 
</pre>
 
 
 
; Where is the database stored?
 
; Where is the database stored?
By default, databases are stored in the <code>BaseXData</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. If you have used the Windows Installer, the directory will be named <code>data</code>, and reside in the application directory.
 
  
=Execute a query=
+
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.
 +
 
 +
==Execute a Query==
 +
 
 
The [[Commands#XQUERY|XQUERY]] command lets you run a query.
 
The [[Commands#XQUERY|XQUERY]] command lets you run a query.
* For example, this query returns all country nodes in the currently opened database.
+
* For example, the following query returns all country nodes in the currently opened factbook database.
 
<code>
 
<code>
 
> [[Commands#XQUERY|XQUERY]] //country
 
> [[Commands#XQUERY|XQUERY]] //country
Line 40: Line 45:
 
</code>
 
</code>
  
=Create a new database=
+
==Database Commands==
Now we will create another database from the [http://files.basex.org/xml/xmark.xml xmark.xml] document.
 
  
* Create the new database, named 'xmark'.
+
* The following command lists all databases than can be opened by the currently logged in user:
 
<code>
 
<code>
> [[Commands#CREATE DB|CREATE DB]] xmark xmark.xml
+
> [[Commands#LIST|LIST]]
 
</code>
 
</code>
  
* Set the new database xmark as the context:
+
* To open an existing database, execute the following:
 
<code>
 
<code>
> [[Commands#OPEN|OPEN]] xmark
+
> [[Commands#OPEN|OPEN]] factbook
 
</code>
 
</code>
  
* Now you can easily execute queries on your new database:
+
* To get information on the currently opened database, type:
 
<code>
 
<code>
> [[Commands#XQUERY|XQUERY]] //people/person/name
+
> [[Commands#INFO|INFO]]
 
</code>
 
</code>
  
=Switch the database=
+
* You can also address a database within your query with the [[Database Module#db:open|db:open]] function:
* You can explicitly query the factbook database with the <code>doc(...)</code> funtion, no matter what the current context is.
 
 
<code>
 
<code>
> [[Commands#XQUERY|XQUERY]] doc("factbook")//country
+
> [[Commands#XQUERY|XQUERY]] db:open("factbook")//country
 
</code>
 
</code>
  
* Otherwise, to set factbook as the current context, execute the following:
+
* To [[Commands|close]] the current database, please type:  
<code>
 
> [[Commands#OPEN|OPEN]] factbook
 
</code>
 
 
 
* The following command lists all databases than can be opened by the currently logged in users:
 
<code>
 
> [[Commands#LIST|LIST]]
 
</code>
 
 
 
=Close or delete a database=
 
* To [[Commands|close]] the current context database, please type:  
 
 
<code>
 
<code>
 
> [[Commands#CLOSE|CLOSE]]
 
> [[Commands#CLOSE|CLOSE]]
 
</code>
 
</code>
  
* Use the [[Commands#DROP DB|DROP DB]] command to delete the xmark database:
+
* Use the [[Commands#DROP DB|DROP DB]] command to delete a database:
 
<code>
 
<code>
> [[Commands#DROP DB|DROP DB]] xmark
+
> [[Commands#DROP DB|DROP DB]] factbook
 
</code>
 
</code>
  
=Create a collection=
+
==Multiple Resources==
'''What is a collection?'''
 
With BaseX you can group documents into one logical collection. A collection is a database that contains two or more documents. Collections accept any type of XML documents, regardless of their structure.
 
 
 
Let's add the xmark.xml document to the factbook database to create a collection. The name of the original factbook database remains.
 
  
* First make sure factbook is opened:
+
One database can contain not only a single, but millions of documents. All documents can have a different structure.
<code>
 
> [[Commands#OPEN|OPEN]] factbook
 
</code>
 
  
* Now add the xmark.xml document:  
+
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#ADD|ADD]] xmark.xml
 
</code>
 
  
=Delete a document=
 
* Deleting a document from a collection is easy:
 
 
<code>
 
<code>
> [[Commands#DELETE|DELETE]] xmark.xml
+
> [[Commands#CREATE DB|CREATE DB]] store
</code>
+
</code><br/>
 
 
Make sure that the collection, which contains the '''xmark.xml''' document, is opened.
 
 
 
=Delete a collection=
 
Deleting a collection is the same as deleting a database.
 
 
 
* To delete the collection factbook, type:
 
 
<code>
 
<code>
> [[Commands#DROP DB|DROP DB]] factbook
+
> [[Commands#ADD|ADD]] factbook.xml
</code>
+
</code><br/>
 
 
=Get server information=
 
Several commands help to explore the state of a server. For a complete list, please visit the [[Commands]] Section.
 
 
 
* To see all databases on the server, type:
 
 
<code>
 
<code>
> [[Commands#LIST|LIST]]
+
> [[Commands#ADD|ADD]] http://files.basex.org/xml/xmark.xml
 
</code>
 
</code>
  
* To see the general information of the opened database, type:
+
* 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#INFO|INFO]]
+
> [[Commands#DELETE|DELETE]] factbook.xml
 
</code>
 
</code>
  
* To list all sessions that are managed by the server instance, type:
+
==Backup and Restore==
<code>
 
> [[Commands#SHOW USERS|SHOW USERS]]
 
</code>
 
  
=Backup and restore=
 
 
* To backup your database, type:
 
* To backup your database, type:
 
<code>
 
<code>
Line 146: Line 110:
 
</code>
 
</code>
  
'''Where is the backup-file stored?'''
+
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>.
The backup-file is stored in the database directory.
+
If a database is to be restored, and if several backups exist, the backup with the newest timestamp is taken.
The file is named <code>factbook-timestamp.zip</code> (<code>db_name-timestamp.zip</code>).
 
To restore the database the file with the newest timestamp is taken.
 
 
 
[[Category:Beginner]]
 

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.