Bureaucrats, editor, reviewer, Administrators
13,550
edits
Changes
Jump to navigation
Jump to search
<p>This step by step tutorial shows article belongs to the [[Getting Started]] Guide. It tells you how to run BaseX in client-server mode from a terminal. You can copy & paste the commands to get it running on your machine.After you finished this tutorial, you will be familiar with the basic BaseX commandscommand-line.</p>
===Download===Download {{Announce|With Version 10, the [http://www.inf.uni-konstanz.de/dbis/basex/download basex.jar]. <br/>We assume that the basex.jar file is located in ''/basex''default admin password has been removed.}}
===Starting the Server===*Navigate to the location of basex.jar (<code>> cd /basex</code>).*You can either start the The database server in interaction mode if you add the -i flag. This allows you to further interact with the server during runtime (add databases or usershandles concurrent [[Transaction_Management|read and write transactions]], [[User Management|manages user permissions]] and [[Logging|logs user interactions]]...).It can be started as follows:
<code>:> java -cp BaseX* Run one of the {{Code|basexserver}} or {{Code|basexserver.jar orgbat}} scripts.basexUse {{Code|basexserverstop}} or {{Code|basexserverstop.BaseXServer -i</code> Alternatively bat}} to gracefully shut down the server can be started without the -i flag. No further administration is possible.<code>: > java -cp * If you have installed BaseX on ''Windows'', click on the '''BaseXHTTP Server (Start)''' icon, which will start both the HTTP Server used for [[#Web Application|Web Applications]] and the database server.jar orgWith '''BaseX HTTP Server (Stop)''', you can shut down the server process.basex.BaseXServer</code>
*A default Unless you have already chosen an admin user is createdpassword yet (e.g., via the Windows installer or a previous installation), you can do so by invoking the {{Command|PASSWORD}} command on your terminal: <br/>:Username: admin<br/>:Password: admin<br/>
:You can change the password with the [[Commands|PASSWORD]] command.
*Alternatively adding the <code>-i</code> flag lets you interact (execute commands, add databases or users) with the server during runtime.
<code>
:> java -cp BaseX.jar org.basex.BaseXServer -i
</code>
*Once the server has successfully started you see the following lines:
BaseXServer basexserver -c PASSWORDBaseX [Server]Server was started(port: 1984).Password: _
===Starting By default, the Client===*Open a new terminal window, make sure you are in server listens to the right directory.*Execute::<code>> java -cp BaseX.jar orgport {{Code|1984}}.basex.BaseXClient</code><br/>*If you haven't changed the password with Pressing {{Code|Ctrl+c}} will close all connections and databases and gracefully shut down the server, you can login as default user (admin/admin)process.
==First Operations==To get familiar with BaseX we suggest Various [[Command-Line_Options#Server|command-line options]] are available to execute simplify batch processing. The [[Start_Scripts|start script]] can be adjusted for individual purposes (e.g. if the following basic operationsdefault memory limit is too restrictive).
If everything works you see the following linesDatabase clients are started similarly:<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.
===* Run one of the {{Code|basexclient}} or {{Code|basexclient.bat}} scripts.* Execute a query===To run a query the xquery following command is used: {{Code|java -cp BaseX.jar org.basex. After BaseXClient}}* If you have installed BaseX on ''Windows'xquery', click on the '' you can insertany valid xquery you like'BaseX Client''' icon. <br/>This query returns all the countries in the database.:<code> > xquery //country</code><br/>
If you wishAt startup, you can also save need to enter your query in a file, and run it on basex.:<code>> run /pathToQuery/querycredentials.txt</code>
===Create an another database / switch between databases===Now we will create an another database. You can get For further details, have a look at the xml document from here [http://phobos101.inf.uni[Command-Line_Options#Client|command-konstanz.de/basex/demoline options]] and the [[Start_Scripts|start script]].:<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>=Introduction=
Now you can simply type your xquery::<code>> xquery 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//people/person/name</code>URIs to resources need to be resolvable by the server (file contents will not be transfered to the server).
If you want to query Username and password can also be specified as command-line option. To evaluate commands without entering the factbook database console mode, you can access it by explicitly naming it with use the doc()<code>-function.:c</code>option on the command line: <pre> xquery doc(basexclient -V -Uadmin -P... -c "factbook")//countryCREATE DB input <example/code>; XQUERY /"
If you want to set the factbook database as the context, you can use:Database 'input' created in 13.85 ms.:<codeexample/>> open factbookQuery:</code>
To see which database is opened, useParsing:0.18 msCompiling:<code>0.04 ms> show databasesEvaluating: 0.12 msPrinting: 0.07 ms</code>Total Time: 0.41 ms
===Close or delete a database===Hit(s): 1 ItemIf you want to close the opened database, simply typeUpdated:0 ItemsPrinted:<code>10 Bytes> closeRead Locking: local [input]</code>Write Locking: none
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, regardlessof 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 whichcontains the document has to be openedQuery "user" executed in 0. ===Delete a collection===Deleting a collection is the same as deleting a database41 ms.If you want to delete the collection factbook, type::<code>> drop factbook</code> ===Getting information about the server===To see all databases on the server, 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 Restore===To backup your database, type::<code>> backup factbook</codepre>
To restore your database, type::<code>> restore factbook</code>=Language Bindings=
'''Where is If you want to communicate with the backup-file stored?'''database server programmatically, we provide clients for various [[Clients|programming languages]].
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.=Changelog=
==See also ==;Version 10.0[[BaseX Standalone]], [[BaseX GUI]], [[Getting Started Guide]], [[Advanced User Portal]][[Category:Beginner]][[Category* Updated:Server]]The default admin password has been removed.
no edit summary
=Startup=
==RequirementsServer==Java 1.6 is required to run newer versions of BaseX. If you need help installing Java 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.
<pre>
</pre>
==Client=Create a database===To create a database you need an 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/>
