Home

Integrating database for usage with Unravel

You can integrate Unravel managed database as well as the external database for usage with Unravel. Unravel supports MySQL/MariaDB and PostgreSQL (Postgres). Check the compatibility matrix for the versions of MySQL/ MariaDB and Postgres that are compatible with the corresponding Unravel platform version.

Configuring Unravel managed database

Unravel supports MySQL/MariaDB or PostgreSQL (Postgres) database. You can integrate Unravel with MySQL/MariaDB by providing a Java JDBC connector. For Postgres, additional files are not required.

MySQL/MariaDB

Important

The following packages must be installed for fulfilling the OS level requirements for MySQL:

  • numactl-libs (for libnuma.so)

  • libaio (for libaio.so)

To integrate with Unravel managed MySQL/MariaDB, do the following:

  1. Create a mysql directory in /tmp. Provide permissions and make it accessible to the user who installs Unravel.

  2. Download the following tar files for MySQL/MariaDB server to /tmp/mysql directory:

    MySQL

    • mysql-5.7.27-linux-glibc2.12-x86_64.tar.gz

    • mysql-connector-java-5.1.48.tar.gz

    MariaDB

    • mariadb-10.4.13-linux-x86_64.tar.gz

    • mariadb-java-client-2.6.0.jar

  3. Run the following command, as an Unravel user, to setup Unravel with MySQL database:

    <unravel_installation_directory>/versions/<build>/setup --extra /tmp/mysql

    This will configure and manage MySQL or MariaDB for usage with Unravel.

PostgreSQL

To configure the Unravel managed Postgres database, all you need to do is run the setup command:

<unravel_installation_directory>/versions/<build>/setup
Configuring external database

For configuring an external MySQL/MariaDB database with Unravel, you must provide the JDBC connector. This can either be as a tar file or as a jar file. For PostgreSQL, additional files are not required.

To integrate Unravel with an external database do the following:

  1. Create a directory for MySQL in /tmp. Provide permissions and make it accessible to the user who installs Unravel.

  2. Add the JDBC connector to /tmp/<MySQL-directory>/<jdbcconnector> directory. This can be either a tar file or a jar file.

  3. Run the following command, as Unravel user, to setup Unravel with an external MySQL/MariaDB database:

    <unravel_installation_directory>/versions/<build>/setup --extra /tmp/<MySQL-directory> --external-database TYPE HOST PORT SCHEMA USERNAME PASSWORD/

# TYPE can be mysql, mariadb, or postgresql.

    For PostgreSQL, since there are no additional files, you can run the same command without --extra:

    <unravel_installation_directory>/versions/<build>/setup --external-database TYPE HOST PORT SCHEMA USERNAME PASSWORD/

    Note

    The TYPE, HOST, PORT, SCHEMA, USERNAME, PASSWORD are optional fields and are prompted if missing.

    This will setup Unravel with an external database.

In this section: