Bureaucrats, editor, reviewer, Administrators
13,550
edits
Changes
Jump to navigation
Jump to search
==Startup==
see the [[Startup Overview]].==Server==
==First Operations==To get familiar with BaseX we suggest to execute {{Announce|With Version 10, the following basic operationsdefault admin password has been removed.}}
===Create a The database===* To create a database you need an XML documentserver handles concurrent [[Transaction_Management|read and write transactions]], e.g. [http://www.w3.org/XML/Binary/2005/03/test-data/Over100/factbook.xml factbook.xml[User Management|manages user permissions]] and [[Logging|logs user interactions]].* Save this document to the /basex directory.* On the client terminal runIt can be started as follows: <code>: > create db factbook factbook.xml</code>
: * 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 have installed BaseX on ''factbookWindows'' - is , click on the name of the database <br/>: ''factbook.xml'BaseX HTTP Server (Start)''' - is the xml fileicon, which is will start both the HTTP Server used to create for [[#Web Application|Web Applications]] and the database<br/> server. With '''BaseX HTTP Server (Stop)''', you can shut down the server process.
If everything works Unless you see the following lines:<pre>Database 'factbook' created in 1950have already chosen an admin password yet (e.83 msg.</pre> ; Where is the database stored?Databases are stored in , via the BaseXData directory which is located in your home folder. Depending on your operating system the location of your home folder varies. For example, on Windows installer or a mac it's /Users/Johnprevious installation), if your name is John. ===Execute a query===The [[Commands|xquery]] command lets you run a query.* For example, this query returns all country nodes in the currently opened database.<code>: > xquery //country</code> * You can also run queries in files:<code>: > run /Users/John/query.xq</code> ===Create a new database===Now we will create another database. You can find do so by invoking the example document here: [http://phobos101.inf.uni-konstanz.de/basex/demo]. * Create the new database, named 'xmark'.<code>: > create db xmark xmark.xml</code> * Set the new database xmark as the context:<code>: > open xmark</code> * Now you can easily execute queries {{Command|PASSWORD}} command on your new database:<code>: > xquery //people/person/name</code> ===Switch the database===* You can explicitly query the factbook database with the doc()-funtion, no matter what the current context is.<code>: > xquery doc("factbook")//country</code> * Otherwise, to set factbook as the current context, execute the following:<code>: > open factbook</code> * To list the current context, type:<code>: > show databases</code> That yields the following linesterminal:
1 opened databasebasexserver -c PASSWORDBaseX [Server]Server was started (sport: 1984).Password:- factbook (1x)_
===Close or delete a database===* To [[CommandsBy default, the server listens to the port {{Code|1984}}. Pressing {{Code|Ctrl+c}} will close]] all connections and databases and gracefully shut down the current context database type: <code>: > close</code>server process.
* Use the Various [[CommandsCommand-Line_Options#Server|dropcommand-line options]] command are available to delete simplify batch processing. The [[Start_Scripts|start script]] can be adjusted for individual purposes (e.g. if the xmark database:<code>: > drop db xmark</code>default memory limit is too restrictive).
Let's add the xmark.xml document to the factbook database to create a collection. The name of the original factbook database remains.Database clients are started similarly:
* Now add the xmarkAt startup, you need to enter your credentials.xml document: <code>: > add xmark.xml</code>
===Delete For further details, have a document from a collection===* Deleting a document from a collection is very easy:<code>: > delete xmarklook at the [[Command-Line_Options#Client|command-line options]] and the [[Start_Scripts|start script]].xml</code>
Make sure the collection which contains the xmark.xml document is opened.=Introduction=
===Delete a collection===Deleting a collection 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 same as deleting BaseX server instance. As a databaseconsequence, paths/URIs to resources need to be resolvable by the server (file contents will not be transfered to the server).
* Username and password can also be specified as command-line option. To delete evaluate commands without entering the collection factbookconsole mode, type:you can use the <code>-c</code>option on the command line: : <pre> drop factbookbasexclient -V -Uadmin -P... -c "CREATE DB input <example/code>; XQUERY /"
===Get information about the server===Several commands help to explore the state of a serverDatabase 'input' created in 13. For a complete list visit the [[Commands|commands section]]85 ms.<example/>Query:/
* To see all databases on the server, typeParsing:0.18 ms<code>Compiling: 0.04 msEvaluating: 0.12 msPrinting: > list0.07 ms</code>Total Time: 0.41 ms
* To see which database is currently openedHit(s):1 Item<code>Updated: 0 ItemsPrinted: 10 BytesRead Locking: > show databaseslocal [input]</code>Write Locking: none
* To see the general information of the opened database, type:<code>: > info</code> * To see the users Query "user" executed in BaseX, type:<code>: > show users</code> ===Backup and Restore===To backup your database, type::<code>> backup factbook0.41 ms.</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 database directory.The file is named <code>factbook-timestamp.zip</code> (<code>db_name-timestamp.zip</code>).To restore the database the file with the newest timestamp is taken.=Changelog=
==See also ==;Version 10.0[[Standalone Tutorial]], [[GUI Tutorial]], [[Getting Started]], [[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 administration of BaseX. Visit the [[Commands|commands section]] for a complete list of database commandscommand-line.
<pre>
</pre>
==Client=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. Collections accept any type of XML documents, regardless of their structure.
* First make sure factbook is opened:<code>Run one of the {{Code|basexclient}} or {{Code|basexclient.bat}} scripts.* Execute the following command: > open factbook{{Code|java -cp BaseX.jar org.basex.BaseXClient}}</code>* If you have installed BaseX on ''Windows'', click on the '''BaseX Client''' icon.
