Changes

Jump to navigation Jump to search
2,077 bytes added ,  11:43, 13 July 2020
no edit summary
This page is part of the [[Getting Started]] Section.
The full distributions of BaseX are equipped with a simple browser-based database administration interface, the '''DBA'''. It allows you to create and administrate databases, evaluate queries in realtimereal time, view log files and , monitor logged-in users, manage users, etc. The server-side code is completely written in [[XQuery]] and [[RESTXQ]].
These were our design goals:
* The code base is supposed to help inspire and motivate you developing your own RESTXQ web applications.* The whole XQuery DBA code is very slick; it consumes only 100 less than 150 KB. It uses very plain and simple Javascript code that should run with nearly every browser. The interface is functional, but limited in terms of flashiness JavaScript and interactivityno framework.
* We tried to make the DBA features as self-explanatory as possible. All functionalities are also available via [[Commands]], [[Module Library|XQuery Modules]] or the Java [[GUI]].
* The {{Code|dba}} sub-directory can simply be copied and moved to any other place. All URL paths point to the same directory; it should be straightforward to adjust the RESTXQ path.
Please be aware that it is an obvious '''security risk''' if If you simply put DBA online along with your web page. At , please ensure at the very least, that:* you should change the DBA path and have changed the password of the your BaseX {{Code|admin}} user!, and The DBA * the BaseX process has just not been released, and it is in beta stage.We are looking forward to your reports and feature requests! Patches and extensions are even more welcomestarted with admin privileges.
=Startup=
* Download the '''ZIP Archive''' or the '''Windows Installer''' from the [httphttps://basex.org/download download page]
* Start the [[Startup#BaseX_HTTP_Server|BaseX HTTP Server]]
* Open a browser and visit the URL {{Code|http://localhost:8984/dba}}
On the welcome page, you need to authenticate yourself by entering the name and password of an admin user. The default user is {{Code|admin}}/{{Code|admin}}; after the first login, the password should be changed via the [[DBA#Users|Users]] panel and create additional DBA users. =First StepsLogsAll [[Logging|database logs]] are listed, ordered by creation time in descending order. The interactive filter allows you to search in the users and text columns via regular expressions. The found substrings are highlighted in the output.
On the welcome pageFor each day, you will need to authenticate yourself by entering a username and password. The default user new log files is {{Code|admin}}/{{Code|admin}}created. By specifying a host and port, you Old log files can communicate with a remote BaseX server instance. If you keep the field empty, you will be connected to the local BaseX instanceselected and deleted.
<table cellpadding="0" cellspacingDatabases="0"><tr><td valign="top">The main page of the DBA interface contains a list of all databases on the left.On the right, the global and local options are listed, along with some systeminformation.
With The database panel contains a list of all databases. Databases can be created, optimized and dropped. If a database is selected, the "Create…" buttondatabase resources, a new backups and properties are listed. Queries can be run on single database resources. [[Image:DBA-Databases.png|778px|DBA Databases Panel]] =Queries= XQuery expressions can be createdrun in the Queries panel. If evaluation takes too long, or if it consumes too much memory, the execution will be interrupted. You can choose if your query is updating or not. Inside the editor area, you can press Ctrl-Enter to execute the query. You can press Shift-Ctrl-Enter to run your XQuery expression as updating query (or non-updating, if "Updating" is chosen in the dropdown menu). Existing database queries can be opened, and saved for future operations. All files will be stored in the current DBA working directory. =Files= Remote files can be vieweddownloaded, optimizedopened in the query editor or run as BaseX jobs, and droppednew files can be uploaded. The chosen directory affects the Queries panel. You can edit your RESTXQ code in real time by switching to the RESTXQ or repository directory and opening the corresponding modules.</td><td valign="top">[[Image:blaDBA-Files.png|thumb775px|DBA Main PageFile Panel]]<=Jobs= In the Jobs panel, all queries are listed that are currently being run or queued. You can view details on particular jobs, spot potential bottlenecks, or spot and kill malicious requests. The panel will always list at least one job, which is the one that is currently preparing your HTTP response. =Users= Existing users can be updated and new users can be created. Extra information can be viewed and modified both globally and locally (see [[User Management]] for more information). =Sessions= The Web Sessions table lists all users that are currently registered in an application or the DBA. See the DBA RESTXQ code for information on how clients can be registered and logged out. The Database Sessions table shows clients that are connected via the client/td>server architecture. =Settings= </table>In the settings, you can tweak some DBA options, enforce a garbage collection and view all current global and local databases options.
=Changelog=
 
;Version 9.4
* Updated: Logging was improved for millions of log entries
 
;Version 8.6
* Updated: Always accessible, even if job queue is full
* Removed: Remote connections (to allow for better optimizations and less locking)
 
;Version 8.4
* Added: Editor: Key combination 'Shift-Ctrl-Enter', real time mode removed.
Introduced with Version 8.0.
 
[[Category:Beginner]]
[[Category:GUI]]
Bureaucrats, editor, reviewer, Administrators
13,550

edits

Navigation menu