Changes

Jump to navigation Jump to search
1,241 bytes added ,  10:27, 3 August 2022
This page is part of the [[Getting Started]] Section.
The full distributions of BaseX are equipped with a powerful browser-based database administration interface, the '''DBA'''. It allows you to create and administrate databases, evaluate queries in realtimereal time, view log files, 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 XQuery DBA code is very lean; it consumes only around 100 less than 150 KB. It uses plain and simple backward-compatible Javascript code. 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 subdirectory 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.
If you put DBA online along with your web page, please ensure at the very least that:least…* that you have changed the chosen a strong password of for your BaseX {{Code|admin}} user, and* that the BaseX process has not been started with admin privileges.
=Startup= * Download the '''ZIP Archive''' or the '''Windows Installer''' from the [https://basex.org/download download page]* Start the [[Startup#BaseX_HTTP_Server|BaseX HTTP Server]]* Open a browser and visit the URL {{MarkCode|Updated with Version 8.6http://localhost:8080/dba}} On the welcome page, you need to authenticate yourself by entering the name and password of a user with [[User Management|admin permissions]]. =Logs= All [[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.
* The DBA will now always be accessibleFor each day, even if the job queue a new log files is fullcreated.* Table results have been paginatedOld log files can be selected and deleted.<br/><br/>
=StartupDatabasesThe database panel contains a list of all databases. Databases can be created, optimized and dropped. If a database is selected, the database resources, 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 run 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 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 downloaded, opened in the query editor or run as BaseX jobs, and new 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. [[Image:DBA-Files.png|775px|DBA File Panel]]
* Download the '''ZIP Archive''' or the '''Windows Installer''' from the [http://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}}=Jobs=
=First Steps=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 terminate malicious requests. The panel will always list at least one job, which is the one that is currently preparing your HTTP response.
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 =Users panel.=
<table cellpadding="0" cellspacing="0"><tr><td valign="top">The main page of the DBA interface contains a list of all databases on the leftExisting users can be updated and new users can be created.On the right, the global Extra information can be viewed and modified both globally and local options are listed, along with some systemlocally (see [[User Management]] for more information).
With the "Create…" button, a new database can be created.Existing database can be viewed, optimized, and dropped.</td><td valign="top">[[Image:bla.png|thumb|DBA Main Page]]</td></table>Sessions=
=Editor=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.
In The Database Sessions table shows clients that are connected via the editor panel, you can execute XQuery expressions. If evaluation takes too long, or if it consumes too much memory, it will be interrupted. You need to choose if your query is updating. Inside the editor area, you can press Ctrl-Enter to execute the queryclient/server architecture.
With {{Version|8.6}} of BaseX, remote connections were removed. The resulting RESTXQ allows for better optimizations and reduces system-wide locks.=Settings=
You In the settings, you can press Shift-Ctrl-Enter to run your XQuery expression as updating query (or non-updatingtweak some DBA options, if "Updating" is choosen in the dropdown menu). The realtime mode was removedenforce 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
;Version 8.4
* Added: Editor: Key combination 'Shift-Ctrl-Enter', realtime real time mode removed.
Introduced with Version 8.0.
Bureaucrats, editor, reviewer, Administrators
13,550

edits

Navigation menu