Update/Upgrade Installation

License Replacement

When your license expires, you will receive a new license key from Datavault Builder License Management. This file is usually called datavault_builder_license.lic and is located in the same directory as your docker-compose.yml file.


Recreating the core will terminate any active processes. Please make sure, that no loading processes are performed while executing the replacement.

  1. Replace the existing license file

    Navigate into the folder where the license file is located (default name: datavault_builder_license.lic)

  2. Update Core

    docker-compose up -d --force-recreate core

  3. Restart the API

    docker-compose restart api


If you had any patches applied, make sure to reapply them after the license is replaced and the system is back up.

Version Change

Before Updating/Upgrading your environment to a new version, make sure to back it up. The recommendation for any update is to perform it as green-blue deployment. Therefore, the recommended processes is as follows. Some steps might not be necessary depending on the update/upgrade.

  1. Copy Environment
    • Create a copy of the database of your environment

    • Create a copy of the configuration files (docker-compose, secrets, …)

  2. Apply Changes
    • Apply the changes to the configuration files (new settings in docker-compose, changed secrets).


    Change the version number in the .env-file.


    Check the current Docker-Compose File Configuration for new parameters, which can be required.

    • Start pulling the new images (docker-compose pull)

    • Log into the Support portal of the Datavault Builder, navigate to the download section and get all update Scripts for your database-type (Called DVB 4.*.*.* to 4.*.*.* Databasetype Update). All means: The scripts between your current version number to the target version to install.


    There can be overlapping update files. This happens, if some update script is actually included within another cumulative update. In this case, you can take the cumulative update.

    For example: dvb_4.0.0rc19_to_4.0.1.0_oracle_update is included in dvb_4.0.0.11_to_4.0.2.0_oracle_update.

    • Apply the update scripts one after the other onto the database.


    Before applying the Update Scripts to the database, make sure to stop the application part of the Datavault Builder if it is running (docker-compose down). This means, that also no loading processes should be going on during the update procedure.

    • Start up the environment (docker-compose up -d). Some additional updates might be applied (mainly to the data model).


    Depending on the size of the model and the resources this process can take up to a couple of hours. You can see the progress in the log of the core container (docker-compose logs -tf core)

  3. Go Live
    • Switch the environment with the productive environment.