3.3.2.1. Support for Other DBMSs

In the application project, you can use any DBMS supported by the ORM framework (EclipseLink). Follow the steps below:

  • Specify the type of database in the form of an arbitrary code in the cuba.dbmsType property. The code must be different from those used in the platform: hsql, postgres, mssql, oracle.

  • Implement the DbmsFeatures, SequenceSupport, DbTypeConverter interfaces by classes with the following names: TypeDbmsFeatures, TypeSequenceSupport, and TypeDbTypeConverter, respectively, where Type is the DBMS type code. The package of the implementation class must be the same as of the interface.

  • If you configure the data source in the application, specify the full connection URL in the required format as described in the Connecting to Databases section.

  • Create database init and update scripts in the directories marked with the DBMS type code. Init scripts must create all database objects required by the platform entities (you can copy them from the existing 10-cuba, etc. directories and modify for your database).

  • To create and update the database by Gradle tasks, you need to specify the additional parameters for these tasks in build.gradle:

    task createDb(dependsOn: assemble, type: CubaDbCreation) {
    dbms = 'my'                                            // DBMS code
    driver = 'net.my.jdbc.Driver'                          // JDBC driver class
    dbUrl = 'jdbc:my:myserver://192.168.47.45/mydb'        // Database URL
    masterUrl = 'jdbc:my:myserver://192.168.47.45/master'  // URL of a master DB to connect to for creating the application DB
    dropDbSql = 'drop database mydb;'                      // Drop database statement
    createDbSql = 'create database mydb;'                  // Create database statement
    timeStampType = 'datetime'                             // Date and time datatype - needed for SYS_DB_CHANGELOG table creation
    dbUser = 'sa'
    dbPassword = 'saPass1'
}

task updateDb(dependsOn: assemble, type: CubaDbUpdate) {
    dbms = 'my'                                            // DBMS code
    driver = 'net.my.jdbc.Driver'                          // JDBC driver class
    dbUrl = 'jdbc:my:myserver://192.168.47.45/mydb'        // Database URL
    dbUser = 'sa'
    dbPassword = 'saPass1'
}

It is also possible to add support for the custom database into the CUBA Studio. When integration is implemented, Studio allows developer to use standard dialogs when changing data store settings. Also (the most important) Studio will be able to automatically generate database migration scripts for entities defined in the platform, add-ons and the project. Integration instructions are available in the corresponding section of the Studio User Guide.

A working example of integrating a custom database (Firebird) into the CUBA platform and CUBA Studio can be found here: https://github.com/cuba-labs/firebird-sample.