Using OpenKM with other databases

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

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

hibernate.dialect=org.hibernate.dialect.HSQLDialect
hibernate.hbm2ddl=create

Once the tables are created, change the hibernate.hbm2ddl property from create to none.

Generating database script

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

import java.io.File;

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.setOutputFile("/path/to/schema.sql");
    se.setFormat(true);
    se.create(false, false);		
  }
}

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

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

• MySQL
• PostgreSQL
• MS SQLServer
• Oracle