database-configurations.md

ODK Aggregate - Supported database configurations

Although we only test actively the integration with PostgreSQL, Aggregate also support the MySQL and SQLServer database engines.

Database configuration

Configuring the database backend involves the files jdbc.properties and odk-settings.xml which are located at src/main/resources in this codebase, or at WEB-INF/classes in an exploded WAR webapp.

jdbc.properties

All three supported RDBs use the same configuration file structure. This is an example for PostgreSQL:

jdbc.driverClassName=org.postgresql.Driver
jdbc.resourceName=jdbc/aggregate
jdbc.url=jdbc:postgresql://127.0.0.1/aggregate?autoDeserialize=true
jdbc.username=aggregate
jdbc.password=aggregate
jdbc.schema=aggregate

Driver class names are:

Database	Driver class name
PostgreSQL	org.postgresql.Driver
MySQL	com.mysql.jdbc.Driver
SQLServer	com.microsoft.sqlserver.jdbc.SQLServerDriver

odk-settings.xml

Set the class attribute of the datastore bean with the value that corresponds to the database engine you're using:

<bean id="datastore" class="org.opendatakit.common.persistence.engine.pgres.DatastoreImpl">
  ...
</bean>

Table of posible values:

Database	Class
PostgreSQL	org.opendatakit.common.persistence.engine.pgres.DatastoreImpl
MySQL	org.opendatakit.common.persistence.engine.mysql.DatastoreImpl
SQLServer	org.opendatakit.common.persistence.engine.sqlserver.DatastoreImpl

Database initialization

Run the following SQL scripts to create and prepare a database to be used by Aggregate

PostgreSQL

CREATE USER aggregate WITH PASSWORD 'aggregate';
CREATE DATABASE aggregate WITH OWNER aggregate;
GRANT ALL PRIVILEGES ON DATABASE aggregate TO aggregate;
\connect aggregate;
CREATE SCHEMA aggregate;
ALTER SCHEMA aggregate OWNER TO aggregate;
GRANT ALL PRIVILEGES ON SCHEMA aggregate TO aggregate;

MySQL

CREATE DATABASE aggregate;
CREATE USER aggregate@'%' IDENTIFIED BY 'aggregate';
GRANT ALL ON aggregate.* TO odk@'%' IDENTIFIED BY 'aggregate';
FLUSH PRIVILEGES;

SQLServer

USE master;
go
CREATE DATABASE aggregate;
go
USE aggregate;
go
CREATE SCHEMA aggregate;
go