This page is part of the Getting Started Section. BaseX offers a standalone console mode from which all 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).
First of all, please launch a standalone version of BaseX: double click on the BaseX icon, or run the
basex script. Follow this link for more information (or check out the additional command-line options).
Create a Database
- 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
BaseXData 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. If you are working with the ZIP or EXE distribution, the directory will be named
data and reside in the application directory.
Execute a Query
The XQUERY command lets you run a query.
- For example, this query returns all country nodes in the currently opened database.
> XQUERY //country
- You can also run queries in files:
> RUN /Users/John/query.xq
- The following command lists all databases than can be opened by the currently logged in user:
- To open an existing database, execute the following:
> OPEN factbook
- To get information on the currently opened database, type:
- 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:
- Use the DROP DB command to delete a database:
> DROP DB factbook
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:
- Deleting a document from a database is easy:
> DELETE factbook.xml
Make sure that the database, which contains the addressed document, is currently opened.
Backup and Restore
- To backup your database, type:
> CREATE BACKUP factbook
- To restore your database, type:
> RESTORE factbook
The backup file is stored in the database directory.
The contains the name of the database and a timestamp:
If a database is restored, and if several backups exist, the backup with the newest timestamp is taken.