Jump to navigation Jump to search
Text replacement - "[" to "["
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:
=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.
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). Please note that 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. [http factbook.xml].
* Save this document to your working directory.
* Type in the following command to create and open the database:
; Where is the database stored?
By default, databases are stored in the <code>BaseXDatabasex/data</code> directory, which is located in your home folder.Depending on your [[Configuration]], the location of your home folder varies. For example, on 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. ==Execute a Query==
=Execute a query=
The [[Commands#XQUERY|XQUERY]] command lets you run a query.
* For example, this the following query returns all country nodes in the currently opened factbook database.
> [[Commands#XQUERY|XQUERY]] //country
=Create a new databaseNow we will create another database from the [ xmark.xml] document. * Create and open a new database 'xmark':<code>> [[Database Commands#CREATE DB|CREATE DB]] xmark xmark.xml</code> * If you have create the database before, you can open it as follows:<code>> [[Commands#OPEN|OPEN]] xmark</code> * Execute queries on your database:<code>> [[Commands#XQUERY|XQUERY]] //people/person/name</code> =Switch the database=
* The following command lists all databases than can be opened by the currently logged in user:
> [[Commands#LIST|LIST]]
> [[Commands#OPEN|OPEN]] factbook
* To get information on the currently opened database, type:
> [[Commands#INFO|INFO]]
=Close or delete a database=
* To [[Commands|close]] the current database, please type:
* Use the [[Commands#DROP DB|DROP DB]] command to delete a database:
> [[Commands#DROP DB|DROP DB]] xmarkfactbook
=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.Multiple Resources==
Let's add the xmark.xml document to the factbook One database to create can contain not only a collectionsingle, but millions of documents. The name of the original factbook database remainsAll documents can have a different structure.
* First make sure factbook With the following commands, you can create an empty database and add two documents. It is openedalso possible to address resources via URLs:<code>> [[Commands#OPEN|OPEN]] factbook</code>
* Now add the xmark.xml document:
> [[Commands#ADDCREATE DB|ADDCREATE DB]] xmark.xmlstore</code> =Delete a document=* Deleting a document from a collection is easy:<br/>
> [[Commands#DELETEADD|DELETEADD]] xmarkfactbook.xml</code> 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:<br/>
> [[Commands#DROP DBADD|DROP DBADD]] factbook
=Get server information=Several commands help to explore the state of * Deleting a server. For document from a complete listdatabase is easy, please visit but make sure that the [[Commands]] Section. * To see all databases on database, which contains the serveraddressed document, type:<code>> [[Commands#LIST|LIST]]</code> * To see the general information of the is currently opened database, type:
> [[Commands#INFODELETE|INFODELETE]]factbook.xml
* To list all sessions that are managed by the server instance, type:<code>> [[Commands#SHOW USERS|SHOW USERS]]</code>==Backup and Restore==
=Backup and restore=
* To backup your database, type:
'''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[</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]]
Bureaucrats, editor, reviewer, Administrators


Navigation menu