bueraucrat, Bureaucrats, editor, reviewer, Administrators
907
edits
Changes
Jump to navigation
Jump to search
Created page with "<p>This is a step by step tutorial to get BaseX running in client-server mode via terminals. You can copy & paste the commands to get it running on your machine. After the compl..."
<p>This is a step by step tutorial to get BaseX running in client-server mode via terminals.
You can copy & paste the commands to get it running on your machine.
After the completion of this quick tutorial, you will be familiar with the
basic BaseX commands.</p>
==Requirements==
You need to have Java installed.
If you don't know how to install it, please visit
[http://www.java.com/en/download/help/download_options.xml java.com]. <br/>
We assume that you are familiar with a shell at a basic level.
===Download===
Download the [http://www.inf.uni-konstanz.de/dbis/basex/download basex.jar]. <br/>
In this example we assume that the basex.jar file is stored in the directory ''/basex''.
===Run the Server===
Go to the directory where the basex.jar is stored (<code>> cd /basex</code>) and execute:
:<code>
> java -cp BaseX.jar org.basex.BaseXServer
</code>
A default admin user is created: <br/>
Username: admin<br/>
Password: admin<br/>
The password can be changed using the password command.<br/>
If you want to interact (execute commands, add databases, add users)
with the server, start the server with the <code>-i</code> flag.
:<code>
> java -cp BaseX.jar org.basex.BaseXServer -i
</code>
If the server is succesfully started, this is coming up:
:<pre>BaseXServer [Server] Server was started.</pre>
===Run the Client===
Open a new terminal window, make sure you are in the right directory and execute:
:<code>
> java -cp BaseX.jar org.basex.BaseXClient
</code>
<br/>
If you haven't changed the password with the server,
the default user '''admin''' with the password '''admin''' is available.
==First Operations==
To get to know BaseX, we advise to run some of the following operations to see how it works and
get your first indentations.
===Create a database===
In order to create a database you need a xml-document, e.g.
[http://www.w3.org/XML/Binary/2005/03/test-data/Over100K/factbook.xml factbook.xml].<br/>
Save this document to the /basex directory.
On the client terminal run:
:<code>
> create db factbook factbook.xml
</code>
<br/>
''factbook'' - is the name of the database <br/>
''factbook.xml'' - is the xml file, which is used to create the database<br/>
If everything works, this messege will appear, the time might differ.
<pre>Database 'factbook' created in 1950.83 ms.
</pre>
;Where is the database stored?
It is stored in the BaseXData directory in your home directory.
In my case it's in /Users/JohnDoe/BaseXData/factbook.
===Execute a query===
To run a query the xquery command is used. After '''xquery''' you can insert
any valid xquery you like. <br/>
This query returns all the countries in the database.
:<code>
> xquery //country
</code>
<br/>
If you wish, you can also save your query in a file, and run it on basex.
:<code>
> run /pathToQuery/query.txt
</code>
===Create an another database / switch between databases===
Now we will create an another database. You can get the xml document from here [http://phobos101.inf.uni-konstanz.de/basex/demo].
:<code>
> create db xmark xmark.xml
</code>
To set the new database xmark as the context (the active, opened database), use:
:<code>
> open xmark
</code>
Now you can simply type your xquery:
:<code>
> xquery //people/person/name
</code>
If you want to query the factbook database you can access it by explicitly naming it with the doc()-function.
:<code>
> xquery doc("factbook")//country
</code>
If you want to set the factbook database as the context, you can use:
:<code>
> open factbook
</code>
To see which database is opened, use:
:<code>
> show databases
</code>
===Close or delete a database===
If you want to close the opened database, simple type:
:<code>
> close
</code>
If you want to delete the xmark database, use:
:<code>
> drop db xmark
</code>
===Create a collection===
'''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.
You can put any type of XML documents into the collection, regardless
of their structure.
Now we will add the xmark.xml document to the factbook database,
and thus create a collection. The collection will keep the name factbook.
First make sure factbook is opened:
:<code>
> open factbook
</code>
Now add the xmark.xml document:
:<code>
> add xmark.xml
</code>
===Delete a document from a collection===
Deleting a document from a collection is very easy, just type:
:<code>
> delete xmark.xml
</code>
N.B. The collection has to be the context i.e. the database which
contains the document has to be opened.
===Delete a collection===
Deleting a collection is the same as deleting a database.
If you want to delete the collection factbook, type:
:<code>
> drop factbook
</code>
===Getting information about the server===
To see all databases in BaseX, type:
:<code>
> list
</code>
To see which database is currently opened, type:
:<code>
> show databases
</code>
To see the general information of the opened database, type:
:<code>
> info
</code>
To see the users in BaseX, type:
:<code>
> show users
</code>
===Backup and Restrore===
To backup your database, type:
:<code>
> backup factbook
</code>
To restore your database, type:
:<code>
> restore factbook
</code>
'''Where is the backup-file stored?'''
The backup-file is stored in the BaseXData directory, which is in your home directory.
The file is named factbook-timestamp.zip (db_name-timestamp.zip).
To restore the database the file with the newest timestamp is taken.
You can copy & paste the commands to get it running on your machine.
After the completion of this quick tutorial, you will be familiar with the
basic BaseX commands.</p>
==Requirements==
You need to have Java installed.
If you don't know how to install it, please visit
[http://www.java.com/en/download/help/download_options.xml java.com]. <br/>
We assume that you are familiar with a shell at a basic level.
===Download===
Download the [http://www.inf.uni-konstanz.de/dbis/basex/download basex.jar]. <br/>
In this example we assume that the basex.jar file is stored in the directory ''/basex''.
===Run the Server===
Go to the directory where the basex.jar is stored (<code>> cd /basex</code>) and execute:
:<code>
> java -cp BaseX.jar org.basex.BaseXServer
</code>
A default admin user is created: <br/>
Username: admin<br/>
Password: admin<br/>
The password can be changed using the password command.<br/>
If you want to interact (execute commands, add databases, add users)
with the server, start the server with the <code>-i</code> flag.
:<code>
> java -cp BaseX.jar org.basex.BaseXServer -i
</code>
If the server is succesfully started, this is coming up:
:<pre>BaseXServer [Server] Server was started.</pre>
===Run the Client===
Open a new terminal window, make sure you are in the right directory and execute:
:<code>
> java -cp BaseX.jar org.basex.BaseXClient
</code>
<br/>
If you haven't changed the password with the server,
the default user '''admin''' with the password '''admin''' is available.
==First Operations==
To get to know BaseX, we advise to run some of the following operations to see how it works and
get your first indentations.
===Create a database===
In order to create a database you need a xml-document, e.g.
[http://www.w3.org/XML/Binary/2005/03/test-data/Over100K/factbook.xml factbook.xml].<br/>
Save this document to the /basex directory.
On the client terminal run:
:<code>
> create db factbook factbook.xml
</code>
<br/>
''factbook'' - is the name of the database <br/>
''factbook.xml'' - is the xml file, which is used to create the database<br/>
If everything works, this messege will appear, the time might differ.
<pre>Database 'factbook' created in 1950.83 ms.
</pre>
;Where is the database stored?
It is stored in the BaseXData directory in your home directory.
In my case it's in /Users/JohnDoe/BaseXData/factbook.
===Execute a query===
To run a query the xquery command is used. After '''xquery''' you can insert
any valid xquery you like. <br/>
This query returns all the countries in the database.
:<code>
> xquery //country
</code>
<br/>
If you wish, you can also save your query in a file, and run it on basex.
:<code>
> run /pathToQuery/query.txt
</code>
===Create an another database / switch between databases===
Now we will create an another database. You can get the xml document from here [http://phobos101.inf.uni-konstanz.de/basex/demo].
:<code>
> create db xmark xmark.xml
</code>
To set the new database xmark as the context (the active, opened database), use:
:<code>
> open xmark
</code>
Now you can simply type your xquery:
:<code>
> xquery //people/person/name
</code>
If you want to query the factbook database you can access it by explicitly naming it with the doc()-function.
:<code>
> xquery doc("factbook")//country
</code>
If you want to set the factbook database as the context, you can use:
:<code>
> open factbook
</code>
To see which database is opened, use:
:<code>
> show databases
</code>
===Close or delete a database===
If you want to close the opened database, simple type:
:<code>
> close
</code>
If you want to delete the xmark database, use:
:<code>
> drop db xmark
</code>
===Create a collection===
'''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.
You can put any type of XML documents into the collection, regardless
of their structure.
Now we will add the xmark.xml document to the factbook database,
and thus create a collection. The collection will keep the name factbook.
First make sure factbook is opened:
:<code>
> open factbook
</code>
Now add the xmark.xml document:
:<code>
> add xmark.xml
</code>
===Delete a document from a collection===
Deleting a document from a collection is very easy, just type:
:<code>
> delete xmark.xml
</code>
N.B. The collection has to be the context i.e. the database which
contains the document has to be opened.
===Delete a collection===
Deleting a collection is the same as deleting a database.
If you want to delete the collection factbook, type:
:<code>
> drop factbook
</code>
===Getting information about the server===
To see all databases in BaseX, type:
:<code>
> list
</code>
To see which database is currently opened, type:
:<code>
> show databases
</code>
To see the general information of the opened database, type:
:<code>
> info
</code>
To see the users in BaseX, type:
:<code>
> show users
</code>
===Backup and Restrore===
To backup your database, type:
:<code>
> backup factbook
</code>
To restore your database, type:
:<code>
> restore factbook
</code>
'''Where is the backup-file stored?'''
The backup-file is stored in the BaseXData directory, which is in your home directory.
The file is named factbook-timestamp.zip (db_name-timestamp.zip).
To restore the database the file with the newest timestamp is taken.
