Changes

Jump to navigation Jump to search
1,388 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 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 slick; 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 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.
* you have changed the password of your BaseX {{Code|admin}} user, and
* the BaseX process has not been started with admin privileges.
 
{{Mark|Updated with Version 8.6:}}
 
* The DBA will now always be accessible, even if the job queue is full.
* Table results have been paginated.
* Support for remote connections was removed. The new RESTXQ code allows for better optimizations and reduces system-wide locks.<br/><br/>
=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. For each day, a new log files is created. Old log files can be selected and deleted. =Databases= The 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]]
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.=Jobs=
<table cellpadding="0" cellspacing="0"><tr><td valign="top">The main page of In the DBA interface contains a list of Jobs panel, all databases queries are listed that are currently being run or queued. You can view details on the leftparticular jobs, spot potential bottlenecks, or spot and kill malicious requests.On the rightThe panel will always list at least one job, which is the global and local options are listed, along with some systeminformationone that is currently preparing your HTTP response.
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>Users=
=Editor=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).
In 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 query.=Sessions=
You can press Shift-Ctrl-Enter to run your XQuery expression as updating query (The Web Sessions table lists all users that are currently registered in an application or non-updating, if "Updating" is choosen in the dropdown menu)DBA. See the DBA RESTXQ code for information on how clients can be registered and logged out.  The realtime mode was removedDatabase Sessions table shows clients that are connected via the client/server architecture. =Settings= 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
;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