Changes

This page is part of the [[Getting Started]] Section.BaseX offers a It introduces you to the standalone console command-line mode from which all [[Commands|database commands]] can be executed.The article on the [[Database Server]] provides numerous examples for running commands in the console mode(note that the GUI does ''not'' interact with the client/server architecture)of BaseX.

First of all, please launch a '''standalone''' version of BaseX: double click on the '''BaseX''' icon, or run the <code>basex</code> script. [[Startup#Standalone|Follow this link]] for more information (or check out the additional [[Command-Line Options#Standalone|The command-line options]]).client can be started as follows:

* All operations will be performed with admin permissions (no password needs to be supplied). Various [[Command-Line_Options#Standalone|command-line options]] are available to simplify batch processing. The [[Start_Scripts|start script]] can be adjusted for individual purposes (e.g. if the default memory limit is too restrictive). The standalone client must not be used if you perform parallel (concurrent) read and write operations on your databases. See [[Startup#Concurrent Operations|Concurrent Operations]] for more details. =Operations= ==Create a Database== To create a database , you need an XML document, e.g. , [httphttps://files.basex.org/xml/factbook.xml factbook.xml].* Save this document to your working directory.* Type and type in the following commandto create and open the database:

> [[Commands#CREATE DB{{Command|CREATE DB]] }} factbook factbook.xml

If everything works you see the following lines:<pre>Database 'factbook' created in 950.83 ms.</pre> ; Where is the database stored?By default, databases are stored in the <code>BaseXDatabasex/data</code> directory, which is located in of your project’s home folderdirectory.Depending on your [[Configuration]], the location of your home folder variesmay vary. For example, on  ==Execute a Query== The {{Command|XQUERY}} command lets you run a Mac it's <code>/Users/John</code>, if your name is Johnquery. If you have used The following query returns all country elements of the Windows Installer, the directory will be named <code>data</code>, and reside in the application directory.currently opened database:

> [[Commands#XQUERY{{Command|XQUERY]] }} //country

* You can also run queries in files: 

> [[Commands#RUN{{Command|RUN]] }} /Userspath/Johnto/query.xq

=Create a new database=Now we will create another database from the [http://files.basex.org/xml/xmark.xml xmark.xml] document.Database Commands==

* Create The following command lists all databases that can be opened by the new database, named 'xmark'.<code>> [[Commands#CREATE DB|CREATE DB]] xmark xmark.xml</code>currently logged-in user:

> [[Commands#OPEN{{Command|OPEN]] xmarkLIST}}

* Now you can easily To open an existing database, execute queries on your new databasethe following:<code>> [[Commands#XQUERY|XQUERY]] //people/person/name</code>

> [[Commands#XQUERY{{Command|XQUERY]] doc("OPEN}} factbook")//country

* Otherwise, to set factbook as To get information on the current contextcurrently opened database, execute the followingtype:<code>> [[Commands#OPEN|OPEN]] factbook</code>

> [[Commands#LIST{{Command|LIST]]INFO}}

=Close or delete You can also address a database=* To [[Commandswithin your query with the {{Function|close]] the current context database, please typeDatabase|db:get}} function: <code>> [[Commands#CLOSE|CLOSE]]</code>

> [[Commands#DROP DB{{Command|DROP DB]] xmarkXQUERY}} db:get("factbook")//country

=Create a collection='''What is a collection?'''With BaseX you can group documents into one logical collection. A collection is a To close the current database that contains two or more documents. Collections accept any , please type of XML documents, regardless of their structure.:

> [[Commands#OPEN{{Command|OPEN]] factbookCLOSE}}

* Now add the xmark.xml documentA database can eventually be dropped again:  

> [[Commands#ADD{{Command|ADD]] xmark.xmlDROP DB}} factbook

=Delete a document=* Deleting a document from a collection is easy:<code>> [[Commands#DELETE|DELETE]] xmark.xml</code>Multiple Resources==

Make sure that the collectionOne database can contain not only a single, which contains the '''xmarkbut millions of documents.xml''' document, is openedAll documents can have a different structure.

=Delete a collection=Deleting a collection is With the same as deleting a following commands, you can create an empty databaseand add two documents.It is also possible to address resources via URLs:

> [[Commands#DROP {{Command|CREATE DB}} store</code><br/><code>> {{Command|DROP DB]] ADD}} factbook.xml</code><br/><code>> {{Command|ADD}} http://files.basex.org/xml/xmark.xml

=Get server information=Several commands help to explore the state of Deleting a server. For document from a complete listdatabase is easy, but make sure that the database, please visit which contains the [[Commands]] Section.addressed document, is currently opened:

> [[Commands#LIST{{Command|LIST]]DELETE}} factbook.xml

* To list all sessions that are managed by the server instanceback up and restore your database, type:<code>> [[Commands#SHOW USERS|SHOW USERS]]</code>

> [[Commands#CREATE BACKUP{{Command|CREATE BACKUP]] }} factbook</code> * To restore your database, type:<br/>

> [[Commands#RESTORE{{Command|RESTORE]] }} factbook

'''Where is the backup-file stored?''' The backup-file is stored in the database directory.The file is named It contains the name of the database and a timestamp: <code>factbook[db-timestamp.zip</code> (<code>db_namename]-[timestamp].zip</code>).To restore the If a database is to be restored, and if several backups exist, the file backup with the newest timestamp is taken. [[Category:Beginner]]