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 command to create and open the database:

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

; Where is By default, databases are stored in the database stored?<code>basex/data</code> directory of your project’s home directory. Depending on your [[Configuration]], the location may vary.

By default, databases are stored in the <code>BaseXData</code> directory, which is located in your home folder.Depending on your [[Configuration]], the location of your home folder varies. For example, on ==Execute a Mac it's <code>/Users/John</code>, if your name is John. If you are working with the ZIP or EXE distribution, the directory will be named <code>data</code> and reside in the application directory.Query==

=Execute The {{Command|XQUERY}} command lets you run a query=. The following query returns all country elements of the currently opened database:

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

* You can also run queries in files: 

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

=More database commands=Database Commands== The following command lists all databases that can be opened by the currently logged-in user:

> [[Commands#CREATE DB{{Command|CREATE DB]] xmark xmark.xml> [[Commands#XQUERY|XQUERY]] //people/person/nameLIST}}

* The To open an existing database, execute the following command lists all databases than can be opened by the currently logged in user: 

> [[Commands#LIST{{Command|LIST]]OPEN}} factbook

* To open an existing get information on the currently opened database, execute the followingtype: 

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

* To You can also address a database within your query with the {{Function|Database|db:get information on the currently opened database, type}} function:<code>> [[Commands#INFO|INFO]]</code>

> [[Commands#XQUERY{{Command|XQUERY]] }} db:openget("factbook")//country

=Close or delete a To close the current database=, please type:

> [[Commands#CLOSE{{Command|CLOSE]]}}

* Use the [[Commands#DROP DB|DROP DB]] command to delete a A databasecan eventually be dropped again: 

> [[Commands#DROP DB{{Command|DROP DB]] xmark}} factbook

=Create a collection=Multiple Resources==

'''What is One database can contain not only a collection?'''single, but millions of documents. All documents can have a different structure.

With BaseX the following commands, you can group documents into one logical collection. A collection is a create an empty database that contains and add two or more documents. Collections accept any type of XML documents, regardless of their structure.It is also possible to address resources via URLs:

> [[Commands#OPEN{{Command|OPEN]] factbookCREATE DB}} store</code><br/><code>* Now add the xmark> {{Command|ADD}} factbook.xml document: </code><br/>

> [[Commands#ADD{{Command|ADD]] }} http://files.basex.org/xml/xmark.xml

=Delete Deleting a document=from a database is easy, but make sure that the database, which contains the addressed document, is currently opened:

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

Make sure that the collection, which contains the '''xmark.xml''' document, is opened. =Delete a collection= Deleting a collection is the same as deleting a database. * To delete the collection factbook, type:<code>> [[Commands#DROP DB|DROP DB]] factbook</code>Backup and Restore==

=Backup To back up and restore=your database, type:

> [[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]]