The service database is the database Runtime uses to store  the meta data.

The meta data consist of the created projects, environments, applications, agents  and parameters.

Also the users and permissions are saved in this service database.


Until version 3.16 you could either select an external database (Oracle, MS SQL Server) or the internal HSQLDB database.

As of version 3.17 we have reduced complexity and do not offer the option for an external database. We always use the internal database.

(info) Existing installations using an external database will still work after upgrading.


HSQLDB


The internal database we use is  HSQLDB (HyperSQL Database), 

HSQLDB is an open source database written in java which can be run standalone and connected to over JDBC.

More information on this java database can be found here: http://hsqldb.org/


Location

Our HSQLDB database is locally saved in the db subfolder of your Runtime Data folder: "<RuntimeDataFolder>\db"

Security

To protect the database the server it should be dedicated for using DATPROF Runtime. Then no users can access the service database and/or the data in the Runtime Data Folder.

Access the Service database 

Normally there is no need to access the Service database,

However, sometimes it is neccesary to perform some maintenance in the database. 

You can access the database with any tool using jdbc.

If the database is running, (Runtime has started and the login screen is requested!) Datprof Runtime is accessible using the hsql protocol over  jdbc , using port 9001 on database runtime. User SA without a password.

If the database is not running you can access the database as a file using the file protocol over jdbc, using the file <RuntimeDataFolder>\db\runtime. User SA without a password. Then the database can only be accessed by one user only.

(info) To configure other values for these HSQLDB defaults check the chapter Runtime Defaults.

HSQLDB Database Manager

From Sourceforge  you can download the  HSQLDB database version 2.4.x and tooling  https://sourceforge.net/projects/hsqldb/files/hsqldb/

Download and unzip this in the Lib folder you find the hsqldb.jar file containing the tools to access any HSQLDB database including the DATPROF Runtime service database.


Use this command:

java -cp <HSQLDB_FOLDER>\lib\hsqldb.jar org.hsqldb.util.DatabaseManagerSwing

or in Windows Explorer

Browse to <HSQLDB_FOLDER>\lib

Double Click on hsqldb.jar



File access

Key

Value

Setting Name

May leave empty, otherwise choose a name

Type

HSQL Database Engine In-Memory

Driver

org.hsqldb.jdbc.JDBCDriver

URL

jdbc:hsqldb:file:<RuntimeDataFolder>\db\runtime

User

SA

Password

<empty>

Server access

Key

Value

Setting Name

May leave empty, otherwise choose a name

Type

HSQL Database Engine In-Memory

Driver

org.hsqldb.jdbc.JDBCDriver

URL

jjdbc:hsqldb:hsql:localhost:9001/runtime

User

SA

Password

<empty>

External Database Manager Tools

To Access the HSQLDB database other tools exist, for instance Dbeaver and DbVisualizer.

Both tools have a community edition available and are much more user friendly then the default HSQLDB database manager.

Especially Dbeaver is very helpfull in finding and loading the desired drivers. (Internet access required)

Another tool is Squirel Sql, an open source project. 


Dbeaver: https://dbeaver.io/

DbVisualizer: https://www.dbvis.com/

Squirel Sql: http://www.squirrelsql.org/