Difference between revisions of "DBA"

From BaseX Documentation
Jump to navigation Jump to search
(18 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
This page is part of the [[Getting Started]] Section.
 
This page is part of the [[Getting Started]] Section.
  
Since {{Version|8.0}}, the full distributions of BaseX are equipped with a simple browser-based database administration interface, the '''DBA'''. The browser frontend was completely written in [[XQuery]] and [[RESTXQ]]. It allows you to create and administer database instances, evaluate queries, view log files and manage users.
+
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 realtime, view log files, manage users, etc. The server-side code is completely written in [[XQuery]] and [[RESTXQ]].
  
 
These were our design goals:
 
These were our design goals:
  
 
* The code base is supposed to help and motivate you developing your own RESTXQ web applications.
 
* The code base is supposed to help and motivate you developing your own RESTXQ web applications.
* The whole DBA code consumes only 100 KB, and it limits to basic Javascript code that should run with nearly every browser. As a result, the interface is functional, but not very flashy and interactive.
+
* The XQuery DBA code consumes only around 100 KB. It uses simple backward-compatible Javascript code. The interface is functional, but limited in terms of flashiness and interactivity.
 +
* 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.
 
* 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.
* 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]].
 
  
As the DBA has just been released, we are looking forward to your feature requests. Patches and extensions are welcome!
+
If you put DBA online along with your web page, please ensure at the very least that:
 +
* 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==
+
=Startup=
  
 
* Download the '''ZIP Archive''' or the '''Windows Installer''' from the [http://basex.org/download download page]
 
* Download the '''ZIP Archive''' or the '''Windows Installer''' from the [http://basex.org/download download page]
Line 18: Line 26:
 
* Open a browser and visit the URL {{Code|http://localhost:8984/dba}}
 
* Open a browser and visit the URL {{Code|http://localhost:8984/dba}}
  
==Start Page==
+
=First Steps=
  
On the welcome page, you will need to authenticate yourself by entering a username and password. The default user is {{Code|admin}}/{{Code|admin}}. By specifying a host and port, you can communicate with a remote BaseX server instance. If you keep the field empty, you will be connected to the local BaseX instance.
+
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.
 
 
==Main Page==
 
  
 
<table cellpadding="0" cellspacing="0">
 
<table cellpadding="0" cellspacing="0">
Line 36: Line 42:
 
</td>
 
</td>
 
</table>
 
</table>
 +
 +
=Editor=
 +
 +
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.
 +
 +
You can press Shift-Ctrl-Enter to run your XQuery expression as updating query (or non-updating, if "Updating" is choosen in the dropdown menu). The realtime mode was removed.
  
 
=Changelog=
 
=Changelog=
 +
 +
;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', realtime mode removed.
  
 
Introduced with Version 8.0.
 
Introduced with Version 8.0.
 
[[Category:Beginner]]
 
[[Category:GUI]]
 

Revision as of 14:51, 3 February 2017

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 realtime, view log files, 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 and motivate you developing your own RESTXQ web applications.
  • The XQuery DBA code consumes only around 100 KB. It uses simple backward-compatible Javascript code. The interface is functional, but limited in terms of flashiness and interactivity.
  • We tried to make the DBA features as self-explanatory as possible. All functionalities are also available via Commands, XQuery Modules or the Java GUI.
  • The 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.

If you put DBA online along with your web page, please ensure at the very least that:

  • you have changed the password of your BaseX admin user, and
  • the BaseX process has not been started with admin privileges.

Template:Mark

  • 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.

Startup

First Steps

On the welcome page, you need to authenticate yourself by entering the name and password of an admin user. The default user is admin/admin; after the first login, the password should be changed via the Users panel.

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 system information.

With the "Create…" button, a new database can be created. Existing database can be viewed, optimized, and dropped.

File:Bla.png
DBA Main Page

Editor

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.

You can press Shift-Ctrl-Enter to run your XQuery expression as updating query (or non-updating, if "Updating" is choosen in the dropdown menu). The realtime mode was removed.

Changelog

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', realtime mode removed.

Introduced with Version 8.0.