Using OpenKM with other databases

From OpenKM Documentation
Jump to: navigation, search

By default, OpenKM uses an embedded database called HSQLDB. This database is integrated into JBoss and offers good performance and low hardware requirements. But sometimes it is not enough for some users who need OpenKM to be deployed within their IT structure, which may be based on another database vendor.

Starting with OpenKM 5, you can create the databases automatically by configuring the hibernate.dialect and hibernate.hbm2ddl properties in OpenKM.cfg.


Once the tables are created, change the hibernate.hbm2ddl property from create to none. Also, a couple of new configuration properties are of interest:


With these properties you can configure if you want to see the SQL sentences generated by Hibernate, and enable Hibernate statistics. Only meaningful for development and fine tuning.

Generating database script

If you want to see the table creation script, create, compile and run this piece of code:


import org.hibernate.cfg.Configuration;
import org.hibernate.tool.hbm2ddl.SchemaExport;

public class Test {
  public static void main(String[] args) throws Exception {
    Configuration cfg = new Configuration();
    cfg.configure(new File("/path/to/hibernate.cfg.xml"));
    SchemaExport se = new SchemaExport(cfg);
    se.create(false, false);

Nota advertencia.png This configuration property should be set before the database creation. Once the database has been initialized don't modify it because you can damage your installation. If your OpenKM installation has been already configured with another database (default one is an embedded one called HSQLDB) you can't switch to another database simply by changing this property.

Here we will discuss the changes needed to run OpenKM with these databases:

Nota clasica.png You can find the DDL SQL sentences for table creation for several databases at

See also: