Command-Line Client - Revision history

CG at 15:43, 4 June 2024

2024-06-04T15:43:28Z

CG: /* Database Commands */

2022-07-25T14:20:03Z

Database Commands

CG at 14:19, 25 July 2022

2022-07-25T14:19:31Z

CG: Text replacement - "db:pre" to "db:get"

2022-07-20T11:43:22Z

Text replacement - "db:pre" to "db:get"

CG: Text replacement - "db:pre(" to "db:get("

2022-07-20T11:32:59Z

Text replacement - "db:pre(" to "db:get("

CG: Text replacement - "db:open" to "db:pre"

2022-07-19T18:54:29Z

Text replacement - "db:open" to "db:pre"

CG at 18:53, 18 July 2022

2022-07-18T18:53:29Z

CG at 18:25, 18 July 2022

2022-07-18T18:25:23Z

CG: Text replacement - "[http://files.basex.org/" to "[https://files.basex.org/"

2020-07-02T10:46:08Z

Text replacement - "[http://files.basex.org/" to "[https://files.basex.org/"

CG: /* Startup */

2019-11-12T12:56:35Z

Startup

@@ Line 28: / Line 28: @@
 ==Execute a Query==
-The {{Commands|XQUERY}} command lets you run a query. The following query returns all country elements of the currently opened database:
+The {{Command|XQUERY}} command lets you run a query. The following query returns all country elements of the currently opened database:
 <code>

@@ Line 72: / Line 72: @@
 </code>
-Use the {{Command|DROP DB}} command to delete a database:
+A database can eventually be dropped again:
 <code>

@@ Line 1: / Line 1: @@
-This page is part of the [[Getting Started]] Section.
+This page is part of the [[Getting Started]] Section. It introduces you to the standalone command-line mode of BaseX.
 =Startup=
@@ Line 9: / Line 8: @@
 * 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).
+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).
-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.
+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=
@@ Line 17: / Line 16: @@
 ==Create a Database==
-* To create a database you need an XML document, e.g. [https://files.basex.org/xml/factbook.xml factbook.xml].
+To create a database, you need an XML document, e.g., [https://files.basex.org/xml/factbook.xml factbook.xml]. Save this document to your working directory and type in the following command to create and open the database:
 <code>
 > {{Command|CREATE DB}} factbook factbook.xml
@@ Line 27: / Line 24: @@
 : '''factbook.xml''' is the initial input of the database<br/>
-; Where is the database stored?
+By default, databases are stored in the <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>basex/data</code> directory, which is located in your home folder.
+==Execute a Query==
-==Execute a Query==
+The {{Commands|XQUERY}} command lets you run a query. The following query returns all country elements of the currently opened database:
 <code>
 > {{Command|XQUERY}} //country
 </code>
-* You can also run queries in files:
+You can also run queries in files:
 <code>
-> {{Command|RUN}} /Users/John/query.xq
+> {{Command|RUN}} /path/to/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 that can be opened by the currently logged-in user:
 <code>
 > {{Command|LIST}}
 </code>
-* To open an existing database, execute the following:
+To open an existing database, execute the following:
 <code>
 > {{Command|OPEN}} factbook
 </code>
-* To get information on the currently opened database, type:
+To get information on the currently opened database, type:
 <code>
 > {{Command|INFO}}
 </code>
-* You can also address a database within your query with the {{Function|Database|db:get}} function:
+You can also address a database within your query with the {{Function|Database|db:get}} function:
 <code>
 > {{Command|XQUERY}} db:get("factbook")//country
 </code>
-* To close the current database, please type:
+To close the current database, please type:
 <code>
 > {{Command|CLOSE}}
 </code>
-* Use the {{Commands|DROP DB}} command to delete a database:
+Use the {{Command|DROP DB}} command to delete a database:
 <code>
 > {{Command|DROP DB}} factbook
@@ Line 93: / Line 94: @@
 </code>
-* Deleting a document from a database is easy, but make sure that the database, which contains the addressed document, is currently opened:
+Deleting a document from a database is easy, but make sure that the database, which contains the addressed document, is currently opened:
 <code>
 > {{Command|DELETE}} factbook.xml
@@ Line 100: / Line 102: @@
 ==Backup and Restore==
-* To back up your database, type:
+To back up and restore your database, type:
 <code>
 > {{Command|CREATE BACKUP}} factbook
-</code>
+</code><br/>
 <code>
 > {{Command|RESTORE}} factbook

@@ Line 62: / Line 62: @@
 </code>
-* You can also address a database within your query with the {{Function|Database|db:pre}} function:
+* You can also address a database within your query with the {{Function|Database|db:get}} function:
 <code>
 > {{Command|XQUERY}} db:get("factbook")//country

@@ Line 64: / Line 64: @@
 * You can also address a database within your query with the {{Function|Database|db:pre}} function:
 <code>
-> {{Command|XQUERY}} db:pre("factbook")//country
+> {{Command|XQUERY}} db:get("factbook")//country
 </code>

@@ Line 21: / Line 21: @@
 * Type in the following command to create and open the database:
 <code>
-> [[Commands#CREATE DB|CREATE DB]] factbook factbook.xml
+> {{Command|CREATE DB}} factbook factbook.xml
 </code>
@@ Line 34: / Line 34: @@
 ==Execute a Query==
-The [[Commands#XQUERY|XQUERY]] command lets you run a query.
+The {{Commands|XQUERY}} command lets you run a query.
 * For example, the following query returns all country nodes in the currently opened factbook database.
 <code>
-> [[Commands#XQUERY|XQUERY]] //country
+> {{Command|XQUERY}} //country
 </code>
 * You can also run queries in files:
 <code>
-> [[Commands#RUN|RUN]] /Users/John/query.xq
+> {{Command|RUN}} /Users/John/query.xq
 </code>
 ==Database Commands==
-* The following command lists all databases than can be opened by the currently logged in user:
+* The following command lists all databases that can be opened by the currently logged-in user:
 <code>
-> [[Commands#LIST|LIST]]
+> {{Command|LIST}}
 </code>
 * To open an existing database, execute the following:
 <code>
-> [[Commands#OPEN|OPEN]] factbook
+> {{Command|OPEN}} factbook
 </code>
 * To get information on the currently opened database, type:
 <code>
-> [[Commands#INFO|INFO]]
+> {{Command|INFO}}
 </code>
-* You can also address a database within your query with the [[Database Module#db:open|db:open]] function:
+* You can also address a database within your query with the {{Function|Database|db:open}} function:
 <code>
-> [[Commands#XQUERY|XQUERY]] db:open("factbook")//country
+> {{Command|XQUERY}} db:open("factbook")//country
 </code>
 * To [[Commands|close]] the current database, please type:
 <code>
-> [[Commands#CLOSE|CLOSE]]
+> {{Command|CLOSE}}
 </code>
 * Use the [[Commands#DROP DB|DROP DB]] command to delete a database:
 <code>
-> [[Commands#DROP DB|DROP DB]] factbook
+> {{Command|DROP DB}} factbook
 </code>
@@ Line 84: / Line 84: @@
 <code>
-> [[Commands#CREATE DB|CREATE DB]] store
+> {{Command|CREATE DB}} store
 </code><br/>
 <code>
-> [[Commands#ADD|ADD]] factbook.xml
+> {{Command|ADD}} factbook.xml
 </code><br/>
 <code>
-> [[Commands#ADD|ADD]] http://files.basex.org/xml/xmark.xml
+> {{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|DELETE]] factbook.xml
+> {{Command|DELETE}} factbook.xml
 </code>
 ==Backup and Restore==
-* To backup your database, type:
+* To back up your database, type:
 <code>
-> [[Commands#CREATE BACKUP|CREATE BACKUP]] factbook
+> {{Command|CREATE BACKUP}} factbook
 </code>
 * To restore your database, type:
 <code>
-> [[Commands#RESTORE|RESTORE]] factbook
+> {{Command|RESTORE}} factbook
 </code>
-The backup file is stored in the database directory.
+The backup file is stored in the database directory. 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.