Command-Line Client

From BaseX Documentation

Jump to: navigation, search

This page is part of the Getting Started Section. BaseX offers a standalone mode in which all database commands can be executed from the command line or console. The article on the Database Server provides numerous examples for running commands in the standalone mode. (Note that the standalone mode does not interact with the client/server architecture.)


[edit] Startup

First of all, launch a standalone version of BaseX: double click on the BaseX icon (Windows only) or run the basex script. Click on the following links to find more information on starting the standalone mode, the standalone mode's start script or the standalone mode's command-line options.

[edit] Create a 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.

[edit] Execute a Query

The XQUERY command lets you run a query.

> XQUERY //country

> RUN /Users/John/query.xq

[edit] Database Commands


> OPEN factbook


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


> DROP DB factbook

[edit] 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:

> CREATE DB store
> ADD factbook.xml

> DELETE factbook.xml

[edit] Backup and Restore

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

Personal tools