Bureaucrats, editor, reviewer, Administrators
13,550
edits
Changes
Jump to navigation
Jump to search
: ''factbook'' - is {{Announce|With Version 10, the name of the database <br/>: ''factbookdefault admin password has been removed.xml'' - is the xml file, which is used to create the database<br/> }}
If everything works you see the following lines:<pre>Database 'factbook' created in 1950.83 ms.</pre> ; Where is the The database stored?Databases are stored in the BaseXData directory which is located in your home folder.Depending on your operating system the location of your home folder varies. For exampleserver handles concurrent [[Transaction_Management|read and write transactions]], on a mac it's <code>/Users/John</code>, if your name is John.If you have used the Windows installer, the database directory will reside in the application directory. ==Execute a query==The [[CommandsUser Management|manages user permissions]] and [[Logging|xquerylogs user interactions]] command lets you run a query.* For example, this query returns all country nodes in the currently opened database.<code>: > XQUERY //country</code> * You It can also run queries in filesbe started as follows:<code>: > RUN /Users/John/query.xq</code>
==Create a new database==* Run one of the {{Code|basexserver}} or {{Code|basexserver.bat}} scripts. Use {{Code|basexserverstop}} or {{Code|basexserverstop.bat}} to gracefully shut down the server.Now we * If you have installed BaseX on ''Windows'', click on the '''BaseX HTTP Server (Start)''' icon, which will create another start both the HTTP Server used for [[#Web Application|Web Applications]] and the databaseserver. You With '''BaseX HTTP Server (Stop)''', you can find shut down the example document here: [http://phobos101.inf.uni-konstanz.de/basex/demo]server process.
* Create the new database, named 'xmark'Unless you have already chosen an admin password yet (e.<code>: > CREATE DB xmark xmarkg.xml</code> * Set , via the new database xmark as the context:<code>: > OPEN xmark</code> * Now Windows installer or a previous installation), you can easily execute queries do so by invoking the {{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 DBxmark</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==* 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 server information==Several commands help to explore the state of a serverDatabase 'input' created in 13. For a complete list, please visit the [[Commands]] Section85 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 Usage]][[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.
=Startup=Start BaseX server and client==First of all, please launch a Server and Client instance of BaseX. Double click on the '''BaseX Server/Client''' icons, or run the <code>basexserver</code> and <code>basexclient</code> scripts. [[Startup#BaseX Server|Follow this link]] for more information.
==Create a databaseServer==* To create a database you need an XML document, e.g. [http://www.w3.org/XML/Binary/2005/03/test-data/Over100/factbook.xml factbook.xml].* Save this document to the directory your working in.* On the client terminal, run: <code>: > CREATE DB factbook factbook.xml</code>
<pre>
</pre>
==Create a collectionClient=='''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.
