Bureaucrats, editor, reviewer, Administrators
13,550
edits
Changes
Jump to navigation
Jump to search
===Starting the Server===*Navigate to the location of basex.jar (<code>> cd /basex</code>).*You can either start the server in interaction mode if you add the -i flag. This allows you to further interact with {{Announce|With Version 10, the server during runtime (add databases or users, ...)default admin password has been removed.}}
<code>:> java -cp BaseXThe database server handles concurrent [[Transaction_Management|read and write transactions]], [[User Management|manages user permissions]] and [[Logging|logs user interactions]].jar org.basex.BaseXServer -i</code> :Or the server It can be started alternatively without the -i flag. Note, that you have to restart the server to execute further commands from this shell.<code>as follows: > java -cp BaseX.jar org.basex.BaseXServer</code>
===Starting Unless you have already chosen an admin password yet (e.g., via the Client===*Open Windows installer or a new terminal windowprevious installation), make sure you are in can do so by invoking the right directory (/basex).*Execute the following to start the client:<code>{{Command|PASSWORD}} command on your terminal:> java -cp BaseX.jar org.basex.BaseXClient</code>
*If you haven't changed the password with the server, you can login as default user (admin/admin).<pre>basexserver -c PASSWORD==First Operations==To get familiar with BaseX we suggest to execute the following basic operations. ===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.xmlServer].<br/>Save this document to the /basex directory.On the client terminal runServer was started (port: :<code>> create db factbook factbook.xml</code><br/>''factbook'' - is the name of the database <br/>''factbook1984).xml'' - is the xml file, which is used to create the database<br/> If everything works you see the following linesPassword:<pre>Database 'factbook' created in 1950.83 ms._
;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 By default, the xquery command is usedserver listens to the port {{Code|1984}}. After '''xquery''' you can insertany valid xquery you like. <br/>This query returns Pressing {{Code|Ctrl+c}} will close all connections and databases and gracefully shut down the countries in the databaseserver process.:<code> > xquery //country</code><br/>
If you wish, you Various [[Command-Line_Options#Server|command-line options]] are available to simplify batch processing. The [[Start_Scripts|start script]] can also save your query in a file, and run it on basexbe adjusted for individual purposes (e.g.:<code>> run /pathToQuery/queryif the default memory limit is too restrictive).txt</code>
To set the new database xmark as the context (the active, opened database), useDatabase clients are started similarly::<code>> open xmark</code>
Now you can simply type your xquery:* Run one of the {{Code|basexclient}} or {{Code|basexclient.bat}} scripts.* Execute the following command:<code>{{Code|java -cp BaseX.jar org.basex.BaseXClient}}> xquery //people/person/name</code>* If you have installed BaseX on ''Windows'', click on the '''BaseX Client''' icon.
If At startup, you want need to query the factbook database you can access it by explicitly naming it with the doc()-functionenter your credentials.:<code> > xquery doc("factbook")//country</code>
If you want to set For further details, have a look at the factbook database as [[Command-Line_Options#Client|command-line options]] and the context, you can use::<code>> open factbook</code>[[Start_Scripts|start script]].
To see which database is opened, use::<code>> show databases</code>=Introduction=
===Close or delete a database===If you want The BaseX command-line client provides similar features to close the opened database[[Command-Line Client|standalone client]]. The major difference is that all commands will be executed by the BaseX server instance. As a consequence, simply type::<code>> close<paths/code>URIs to resources need to be resolvable by the server (file contents will not be transfered to the server).
If you want to delete Username and password can also be specified as command-line option. To evaluate commands without entering the xmark databaseconsole mode, you can use::the <code>-c</code>option on the command line: <pre> drop db xmarkbasexclient -V -Uadmin -P... -c "CREATE DB input <example/code>; XQUERY /"
===Create a collection===Database 'input''What is a collection?'''With BaseX you can group documents into one logical collectioncreated in 13.85 ms.A collection is a database that contains two or more documents.<example/>You can put any type of XML documents into the collection, regardlessQuery:of their structure./
Now we will add the xmarkParsing: 0.xml document to the factbook database,18 msand thus create a collectionCompiling: 0. The collection will keep the name factbook04 msEvaluating: 0.12 msPrinting: 0.07 msTotal Time: 0.41 ms
First make sure factbook is openedHit(s):1 ItemUpdated:<code>0 Items> open factbookPrinted: 10 BytesRead Locking: local [input]</code>Write Locking: none
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.eQuery "user" executed in 0. the database whichcontains the document has to be opened41 ms. ===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 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
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.
=Startup=Requirements==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]. We assume that you are familiar with a shell at a basic level.
==Server=Download===Download the [http://www.inf.uni-konstanz.de/dbis/basex/download basex.jar]. In scope of this tutorial we assume that the basex.jar file is located in ''/basex''.
*A default admin user is created (Run one of the {{Code|basexserver}} or {{Code|basexserver.bat}} scripts. Use {{Code|basexserverstop}} or {{Code|basexserverstop.bat}} to gracefully shut down the server.* If you can change have installed BaseX on ''Windows'', click on the password with '''BaseX HTTP Server (Start)''' icon, which will start both the HTTP Server used for [[Commands#Web Application|PASSWORDWeb Applications]] command)::Username: admin:Password: admin *Once and the database server has successfully started . With '''BaseX HTTP Server (Stop)''', you see can shut down the following lines:<pre>BaseXServer [Server]Server was startedserver process.</pre>
</pre>
==Client=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>
