Changes

Jump to navigation Jump to search
1,073 bytes removed ,  13:40, 1 April 2019
m
This page is part of the [[Getting Started]] Section.
BaseX offers a standalone console mode from in which all [[Commands|database commands]] can be executedfrom the command line or console.The article on the [[Database Server]] provides numerous examples for running commands in the console standalone mode.(note Note that the GUI standalone mode does ''not'' interact with the client/server architecture.).
=Startup=
First of all, please launch a '''standalone''' version of BaseX: double click on the '''BaseX''' icon, (Windows only) or run the <code>basex</code> script. Click on the following links to find more information on [[Startup#Standalone_Mode|starting the standalone mode]], [[Start_Scripts#Standalone|Follow this linkthe standalone mode's start script]] for more information (or check out the additional [[Command-Line OptionsLine_Options#Standalone|the standalone mode's command-line options]]).
=Create a databaseDatabase=
* To create a database you need an XML document, e.g. [http://files.basex.org/xml/factbook.xml factbook.xml].
* Save this document to your working directory.
* Type in the following commandto create and open the database:
<code>
> [[Commands#CREATE DB|CREATE DB]] factbook factbook.xml
; 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.
<code>
> [[Commands#XQUERY|XQUERY]] //country
</code>
=Create a new database= Now we will create another database from the [http://files.basex.org/xml/xmark.xml 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:
 
<code>
> [[Commands#LIST|LIST]]
<code>
> [[Commands#OPEN|OPEN]] factbook
</code>
 
* To get information on the currently opened database, type:
<code>
> [[Commands#INFO|INFO]]
</code>
</code>
=Close or delete a database=
* To [[Commands|close]] the current database, please type:
<code>
* Use the [[Commands#DROP DB|DROP DB]] command to delete a database:
<code>
> [[Commands#DROP DB|DROP DB]] xmarkfactbook
</code>
=Create a collectionMultiple Resources='''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. Let's add the xmark.xml document to the factbook database to create a collection. The name of the original factbook database remains.
* First make sure factbook is opened:<code>> [[Commands#OPEN|OPEN]] factbook</code>One database can contain not only a single, but millions of documents. All documents can have a different structure.
* Now With the following commands, you can create an empty database and add the xmarktwo documents.xml documentIt is also possible to address resources via URLs: <code>> [[Commands#ADD|ADD]] xmark.xml</code>
=Delete a document=
* Deleting a document from a collection is easy:
<code>
> [[Commands#DELETECREATE DB|DELETECREATE DB]] xmark.xmlstore</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/>
<code>
> [[Commands#DROP DBADD|DROP DBADD]] factbook.xml</code> =Get server information=Several commands help to explore the state of a server. For a complete list, please visit the [[Commands]] Section. * To see all databases on the server, type:<br/>
<code>
> [[Commands#LISTADD|LISTADD]]http://files.basex.org/xml/xmark.xml
</code>
* To see Deleting a document from a database is easy, but make sure that the general information of database, which contains the addressed document, is currently opened database, type:
<code>
> [[Commands#INFODELETE|INFODELETE]]factbook.xml
</code>
* 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:
<code>
</code>
'''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]]
Bureaucrats, editor, reviewer, Administrators
13,550

edits

Navigation menu