Changes

Jump to navigation Jump to search
187 bytes removed ,  17:43, 4 June 2024
no edit summary
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.
=Startup=
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:
=Create a Database=* Run one of the {{Code|basex}} or {{Code|basex.bat}} scripts.* If you have installed BaseX on ''Windows'', click on the '''BaseX Standalone''' icon.
* 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:
<code>
> [[Commands#CREATE DB{{Command|CREATE DB]] }} factbook factbook.xml
</code>
: '''factbook.xml''' is the initial input of the database<br/>
; 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=query. The following query returns all country elements of the currently opened database:
The [[Commands#XQUERY|XQUERY]] command lets you run a query.
* For example, this query returns all country nodes in the currently opened database.
<code>
> [[Commands#XQUERY{{Command|XQUERY]] }} //country
</code>
* You can also run queries in files: 
<code>
> [[Commands#RUN{{Command|RUN]] }} /Userspath/Johnto/query.xq
</code>
==Database Commands== The following command lists all databases that can be opened by the currently logged-in user:
* The following command lists all databases than can be opened by the currently logged in user:
<code>
> [[Commands#LIST{{Command|LIST]]}}
</code>
* To open an existing database, execute the following: 
<code>
> [[Commands#OPEN{{Command|OPEN]] }} factbook
</code>
* To get information on the currently opened database, type: 
<code>
> [[Commands#INFO{{Command|INFO]]}}
</code>
* You can also address a database within your query with the [[{{Function|Database Module#db:open|db:open]] get}} function: 
<code>
> [[Commands#XQUERY{{Command|XQUERY]] }} db:openget("factbook")//country
</code>
* To [[Commands|close]] the current database, please type:  
<code>
> [[Commands#CLOSE{{Command|CLOSE]]}}
</code>
* Use the [[Commands#DROP DB|DROP DB]] command to delete a A databasecan eventually be dropped again
<code>
> [[Commands#DROP DB{{Command|DROP DB]] }} factbook
</code>
==Multiple Resources==
One database can contain not only a single, but millions of documents. All documents can have a different structure.
<code>
> [[Commands#CREATE DB{{Command|CREATE DB]] }} store</code><br/><code>> [[Commands#ADD{{Command|ADD]] }} factbook.xml</code><br/><code>> [[Commands#ADD{{Command|ADD]] }} http://files.basex.org/xml/xmark.xml
</code>
* Deleting a document from a database is easy, but make sure that the database, which contains the addressed document, is currently opened
<code>
> [[Commands#DELETE{{Command|DELETE]] }} factbook.xml
</code>
Make sure that the database, which contains the addressed document, is currently opened.==Backup and Restore==
=Backup To back up and Restore=restore your database, type:
* To backup your database, type:
<code>
> [[Commands#CREATE BACKUP{{Command|CREATE BACKUP]] }} factbook</code> * To restore your database, type:<br/>
<code>
> [[Commands#RESTORE{{Command|RESTORE]] }} factbook
</code>
The backup file is stored in the database directory.The It contains the name of the database and a timestamp: <code>[db-name]-[timestamp].zip</code>.If a database is to be restored, and if several backups exist, the backup with the newest timestamp is taken.
Bureaucrats, editor, reviewer, Administrators
13,554

edits

Navigation menu