Changes

Jump to navigation Jump to search
409 bytes added ,  15:31, 10 April 2019
no edit summary
==Configuration Files==
 BaseX maintains some configuration files, which are stored in the project’s [[#Home Directory|Home Directory]](note that, depending on your OS and configuration, files and folders with a '.' prefix may be hidden):
* <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>.basexperm</code> contains user name, passwords, and permissions (see [[#User and Log Files|last paragraph]]).
* <code>.basexevents</code> contains all existing events (see [[Events]]).
* <code>.basexhistory</code> contains commands that have been typed in most recently.
* <code>.basexhome</code> can be created by a user to mark a folder as [[#Home Directory|home directory]]. Its contents do not matter, so it is usually empty.
 
Note that:
 
* 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 may be started from different locations, it dynamically determines its home directory:
* First, the '''Java system property''' {{monoCode|"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 {{monoCode|"user.dir"}}) is chosen if the {{monoCode|.basex}} configuration or {{Code|.basexhome}} file is found in this directory. * OtherwiseIf not, the configuration file is searched in the '''application directory''' (the folder in which the project BaseX is located)is chosen if one of these two files is found. * 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), from the Java system property {{monoCode|"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 what directory was chosen. You can run the XQuery expression <code>Q{org.basex.util.Prop}HOMEDIR()</code> to find out.
==Database Directory==
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 you run the standalone JAR archive, all of these files are stored in a folder in the home database. The database root directory,which is named {{MonoCode|BaseXDatadata}}. If you use one of the complete distributions, this directory will benamed <code>data</code>, and reside in the application directory.
The database path can be changed as follows:
* GUI: Choose ''Options'' → ''Preferences'' and choose a new database path.
* Server/StandaloneGeneral: edit the {{Option|DBPATH}} option in the {{Code|.basex}} configuration file '''Note: ''' Existing databases will not automatically be moved to the new destination. ==Log Files== Log files are stored in text format in a <code>.logs</code> sub-directory of the database folder (see [[Options#DBPATH|SET DBPATH [pathLogging]]]</code>for more information). =Changelog= ;Version 9.0 * Updated: Detection and configuration of home directory and subdirectories. ;Version 8.0
Note* Updated: After having changed {{Code|.basexperm}} is obsolete. Users are now stored in {{Code|users.xml}} in the database path, all existing databases have to be manually moved to the new locationdirectory (see [[User Management]] for more information).
==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 <code>BaseXData/.logs</code> (see [[Logging]] for more information);Version 7.7
* Updated: The {{Code|.basexhome}} file marks a folder as [[Category: Internals#Home Directory|home directory]].
Bureaucrats, editor, reviewer, Administrators
13,550

edits

Navigation menu