Upgrade to MarkLogic Data Hub

Prerequisites

You need:

Important: Remember to archive your old project files before performing an upgrade.
Important: If you are deploying to a Data Hub Services environment, you must contact Support to upgrade your DHS environment to use Data Hub v5.0.

The notes and steps in this tab are for the following upgrade paths:

  • DHF 4.3 » 5.0

Procedure

  1. In your project root directory, create a build.gradle file with the Grade Properties plugin setting and the Data Hub plugin setting.

    Copy the following to your build.gradle file and replace the com.marklogic.ml-data-hub version number with the Data Hub version that you are using.

       plugins {
          // Gradle Properties plugin
          id 'net.saliman.properties' version '1.4.6'
    
          // Data Hub plugin
          id 'com.marklogic.ml-data-hub' version '5.0.0'
      }
    
    net.saliman.properties Gradle Properties plugin Allows you to create different environments for your Gradle deployment and set up a gradle-{env}.properties file, where {env} is the environment name. When running a Gradle task, you can specify the target environment with the environmentName option. For more information, see https://github.com/stevesaliman/gradle-properties-plugin.
    com.marklogic.ml-data-hub Data Hub plugin Extends the ml-gradle plugin with Data Hub-specific commands.
  2. At your project root, run the Gradle task hubUpdate.

    Running the hubUpdate task with the -i option (info mode) displays specifically what the task does, including configuration settings that changed.

    ./gradlew hubUpdate -igradlew.bat hubUpdate -i

    hubUpdate automatically moves the following artifacts to the new project.

    From old project To Data Hub 5.0.0 project
       your-project-root/plugins/entities/entity1/entity1.entity.json
      ...
      your-project-root/plugins/entities/entityN/entityN.entity.json
    

    The input and harmonize folders remain in the same plugins/entities/entity* folders.

       your-project-root/entities/entity1.entity.json
      ...
      your-project-root/entities/entityN.entity.json
    
    your-project-root/plugins/mappings (the entire directory) your-project-root/mappings
  3. Update your gradle.properties file to change the value of mlDHFVersion to 5.0.0.
    mlDHFVersion=5.0.0
  4. Run the Gradle task mlDeploy.
    ./gradlew mlDeploygradlew.bat mlDeploy

The notes and steps in this tab are for the following upgrade paths:

  • DHF 4.2 » 5.0
  • DHF 4.1 » 5.0
  • DHF 4.0 » 5.0

Procedure

  1. Upgrade to DHF 4.3 to adopt the new roles.
  2. Upgrade from DHF 4.3 to Data Hub 5.0.0.

The notes and steps in this tab are for the following upgrade paths:

  • DHF 3.x and earlier » 5.0

Procedure

  1. Upgrade to DHF 4.3.
  2. Upgrade from DHF 4.3 to Data Hub 5.0.0.