Difference between revisions of "Database Server"

From BaseX Documentation
Jump to navigation Jump to search
 
(21 intermediate revisions by 2 users not shown)
Line 1: Line 1:
This step by step tutorial is part of the [[Getting Started]] Guide.
+
This article belongs to the [[Getting Started]] Guide. It tells you how to run BaseX in client-server mode from command-line.
It shows you how to run BaseX in client-server mode from a terminal. You can copy and paste all commands to get them running on your machine. After you finished this tutorial, you will be familiar with the basic administration of BaseX. Visit the [[Commands|commands section]] for a complete list of database commands.
 
  
==Startup==
+
=Startup=
First of all, please launch a '''Server''' and '''Client''' instance of BaseX: double click on the '''BaseX Server/Client''' icons, or run the <code>basexserver</code> and <code>basexclient</code> scripts. [[Startup#BaseX Server|Follow this link]] for more information (or check out the additional [[Command-Line Options#BaseX Server|command-line options]]).
 
  
==Create a database==
+
==Server==
* To create a database you need an XML document, e.g. [http://files.basex.org/xml/factbook.xml factbook.xml].
 
* Save this document to the directory you are working in.
 
* In the client terminal, type in:
 
<code>
 
> [[Commands#CREATE DB|CREATE DB]] factbook factbook.xml
 
</code>
 
  
: '''factbook''' is the name of the database <br/>
+
The database server handles concurrent [[Transaction_Management|read and write transactions]], [[User Management|manages user permissions]] and [[Logging|logs user interactions]]. It can be started as follows:
: '''factbook.xml''' is the xml file, which is used to create the database<br/>     
 
  
If everything works you see the following lines:
+
* Run one of the {{Code|basexserver}} or {{Code|basexserver.bat}} scripts. Add the {{Code|stop}} keyword to gracefully shut down the server.
<pre>Database 'factbook' created in 950.83 ms.
+
* If you have installed BaseX on ''Windows'', click on the '''BaseX HTTP Server (Start)''' icon, which will start both the HTTP Server used for [[#Web Application|Web Applications]] and the database server. With '''BaseX HTTP Server (Stop)''', you can shut down the server process.
</pre>
 
 
; 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, the server listens to the port {{Code|1984}}. Pressing {{Code|Ctrl+c}} will close all connections and databases and gracefully shut down the server process.
The [[Commands#XQUERY|XQUERY]] command lets you run a query.
 
* For example, this query returns all country nodes in the currently opened database.
 
<code>
 
> [[Commands#XQUERY|XQUERY]] //country
 
</code>
 
  
* You can also run queries in files:
+
Various [[Command-Line_Options#Server|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).
<code>
 
> [[Commands#RUN|RUN]] /Users/John/query.xq
 
</code>
 
  
==Create a new database==
+
==Client==
Now we will create another database from the [http://files.basex.org/xml/xmark.xml xmark.xml] document.
 
  
* Create the new database, named 'xmark'.
+
Database clients are started similarly:
<code>
 
> [[Commands#CREATE DB|CREATE DB]] xmark xmark.xml
 
</code>
 
  
* Set the new database xmark as the context:
+
* Run one of the {{Code|basexclient}} or {{Code|basexclient.bat}} scripts.
<code>
+
* Execute the following command: {{Code|java -cp BaseX.jar org.basex.BaseXClient}}
> [[Commands#OPEN|OPEN]] xmark
+
* If you have installed BaseX on ''Windows'', click on the '''BaseX Client''' icon.
</code>
 
  
* Now you can easily execute queries on your new database:
+
At startup, you need to enter your credentials. The initial passwort of the {{Code|admin}} user is {{Code|admin}}; it can be changed with the {{Code|[[Commands#PASSWORD|PASSWORD]]}} command.
<code>
 
> [[Commands#XQUERY|XQUERY]] //people/person/name
 
</code>
 
  
==Switch the database==
+
For further details, have a look at the [[Command-Line_Options#Client|command-line options]] and the [[Start_Scripts|start script]].
* You can explicitly query the factbook database with the <code>doc(...)</code> funtion, no matter what the current context is.
 
<code>
 
> [[Commands#XQUERY|XQUERY]] doc("factbook")//country
 
</code>
 
  
* Otherwise, to set factbook as the current context, execute the following:
+
=Introduction=
<code>
 
> [[Commands#OPEN|OPEN]] factbook
 
</code>
 
  
* The following command lists all databases than can be opened by the currently logged in users:
+
The BaseX command-line client provides similar features to the [[Command-Line Client|standalone client]]. The major difference is that all commands will be executed by the BaseX server instance. As a consequence, paths/URIs to resources need to be resolvable by the server (file contents will not be transfered to the server).
<code>
 
> [[Commands#LIST|LIST]]
 
</code>
 
  
==Close or delete a database==
+
Username and password can also be specified as command-line option. To evaluate commands without entering the console mode, you can use the <code>-c</code> option on the command line:
* To [[Commands|close]] the current context database, please type:
+
<code>
+
<pre>
> [[Commands#CLOSE|CLOSE]]
+
basexclient -V -Uadmin -Padmin -c "CREATE DB input <example/>; XQUERY /"
</code>
 
  
* Use the [[Commands#DROP DB|DROP DB]] command to delete the xmark database:
+
Database 'input' created in 13.85 ms.
<code>
+
<example/>
> [[Commands#DROP DB|DROP DB]] xmark
+
Query:
</code>
+
/
  
==Create a collection==
+
Parsing: 0.18 ms
'''What is a collection?'''
+
Compiling: 0.04 ms
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.
+
Evaluating: 0.12 ms
 +
Printing: 0.07 ms
 +
Total Time: 0.41 ms
  
Let's add the xmark.xml document to the factbook database to create a collection. The name of the original factbook database remains.
+
Hit(s): 1 Item
 +
Updated: 0 Items
 +
Printed: 10 Bytes
 +
Read Locking: local [input]
 +
Write Locking: none
  
* First make sure factbook is opened:
+
Query "user" executed in 0.41 ms.
<code>
+
</pre>
> [[Commands#OPEN|OPEN]] factbook
 
</code>
 
 
 
* Now add the xmark.xml document:
 
<code>
 
> [[Commands#ADD|ADD]] xmark.xml
 
</code>
 
 
 
==Delete a document==
 
* Deleting a document from a collection is easy:
 
<code>
 
> [[Commands#DELETE|DELETE]] xmark.xml
 
</code>
 
 
 
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>
 
> [[Commands#DROP DB|DROP DB]] factbook
 
</code>
 
 
 
==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>
 
> [[Commands#LIST|LIST]]
 
</code>
 
 
 
* To see the general information of the opened database, type:
 
<code>
 
> [[Commands#INFO|INFO]]
 
</code>
 
 
 
* To list all sessions that are managed by the server instance, type:
 
<code>
 
> [[Commands#SHOW USERS|SHOW USERS]]
 
</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>
 
 
 
'''Where is the backup-file stored?'''
 
  
The backup-file is stored in the database directory.
+
=Language Bindings=
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.
 
  
==See also ==
+
If you want to communicate with the database server programmatically, we provide clients for various [[Clients|programming languages]].
[[Standalone Mode]], [[GUI]], [[Getting Started]], [[Advanced Usage]]
 
[[Category:Beginner]]
 
[[Category:Server]]
 

Latest revision as of 12:15, 15 February 2021

This article belongs to the Getting Started Guide. It tells you how to run BaseX in client-server mode from command-line.

Startup[edit]

Server[edit]

The database server handles concurrent read and write transactions, manages user permissions and logs user interactions. It can be started as follows:

  • Run one of the basexserver or basexserver.bat scripts. Add the stop keyword to gracefully shut down the server.
  • If you have installed BaseX on Windows, click on the BaseX HTTP Server (Start) icon, which will start both the HTTP Server used for Web Applications and the database server. With BaseX HTTP Server (Stop), you can shut down the server process.

By default, the server listens to the port 1984. Pressing Ctrl+c will close all connections and databases and gracefully shut down the server process.

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

Client[edit]

Database clients are started similarly:

  • Run one of the basexclient or basexclient.bat scripts.
  • Execute the following command: java -cp BaseX.jar org.basex.BaseXClient
  • If you have installed BaseX on Windows, click on the BaseX Client icon.

At startup, you need to enter your credentials. The initial passwort of the admin user is admin; it can be changed with the PASSWORD command.

For further details, have a look at the command-line options and the start script.

Introduction[edit]

The BaseX command-line client provides similar features to the standalone client. The major difference is that all commands will be executed by the BaseX server instance. As a consequence, paths/URIs to resources need to be resolvable by the server (file contents will not be transfered to the server).

Username and password can also be specified as command-line option. To evaluate commands without entering the console mode, you can use the -c option on the command line:

basexclient -V -Uadmin -Padmin -c "CREATE DB input <example/>; XQUERY /"

Database 'input' created in 13.85 ms.
<example/>
Query:
/

Parsing: 0.18 ms
Compiling: 0.04 ms
Evaluating: 0.12 ms
Printing: 0.07 ms
Total Time: 0.41 ms

Hit(s): 1 Item
Updated: 0 Items
Printed: 10 Bytes
Read Locking: local [input]
Write Locking: none

Query "user" executed in 0.41 ms.

Language Bindings[edit]

If you want to communicate with the database server programmatically, we provide clients for various programming languages.