Bureaucrats, editor, reviewer, Administrators
13,550
edits
Changes
Jump to navigation
Jump to search
* <code>.basexhome</code> (optional) marks a folder as [[#Home Directory|home directory]] ({{Mark|Introduced with Version 7.7}})
* <code>.basexperm</code> contains user name, passwords, and permissions (see [[#User and Log Files|last paragraph]]).
* <code>.basexevents</code> contains all existing events (see [[Events]]).
A database in BaseX [[Databases]] consists of several binary files, which . These are all bundled located in a folder with directory named by the database name.If the user’s home directory has been chosen as base directory, of the database folders will be stored in a{{Code|BaseXData}} directory. Otherwise, the The database root directory will be is named {{Code|datdadata}}.
→Home Directory
==Configuration Files==
BaseX maintains some configuration files, which are stored in the project’s [[#Home Directory|Home Directory]]:
* <code>.basex</code> contains all options that are relevant for running the server or standalone versions of BaseX.
* <code>.basexgui</code> defines all options relevant to the BaseX GUI.
* <code>.basexhistory</code> contains commands that have been typed in most recently.
* An empty <code>.basexhome</code> file can be added to a directory to mark it as [[#Home Directory|home directory]].
Note that, depending : * Depending on your OS and configuration, files and folders with a '.' prefix may be hidden.* In the [[Web Application]] context, options can be defined in the <code>web.xml</code> file.
==Home Directory==
As BaseX is distributed in different flavors, and as it may be started from different locations, it dynamically determines its home directory:
* First, the '''Java system property''' {{Code|"org.basex.path"}} is checked. If it contains a value, it is chosen as directory path.* If not, the '''current user directory''' (defined by the system property {{Code|"user.dir"}}) is chosen if the {{Code|.basex}} or {{Code|.basexhome}} file is found in this directory. * OtherwiseIf not, the files are searched in the '''application directory''' (the folder in which the BaseX code is located)is chosen if one of these two files is found in that directory. * In all other cases, a {{Code|basex}} subdirectory in the '''user's home directory''' will be returned. The user home directory is retrieved via the {{Code|HOME}} environment variable, or (defined in if unassigned) the Java system property {{Code|"user.home"}}. If BaseX is used in an embedded environment (such as a servlet in a [[Web Application]]) is , it may not immediately be clear which directory was chosen. You can run the XQuery expression <code>Q{org.basex.util.Prop}HOMEDIR()</code> to find out.
==Database Directory==
The database path can be changed as follows:
* GUI: Choose ''Options'' → ''Preferences'' and choose a new database path.
* Server/StandaloneGeneral: <code>[[Options#edit the {{Option|DBPATH}} option in the {{Code|SET DBPATH [path]]]</code>.basex}} configuration file
'''Note:''' Existing databases will not automatically be automatically moved to the new destination.
==User and Log Files==Global users, along with their passwords and permissions, are stored in the <code>.basexperm</code> file in the [[#Home Directory|home directory]]. Local users and permissions are stored inside the database files.Log files are stored in text format in the home directory a <code>BaseXData/.logs</code> sub-directory of the database folder (see [[Logging]] for more information).
=Changelog=
;Version 9.0
* Updated: Detection and configuration of home directory and subdirectories.
;Version 8.0
* Updated: {{Code|.basexperm}} is obsolete. Users are now stored in {{Code|users.xml}} in the database directory (see [[User Management]] for more information).
;Version 7.7
* Updated: the The {{Code|.basexhome}} file marks a folder as [[#Home Directory|home directory]] [[Category: Internals]].
