Upgrade to MarkLogic Data Hub 6.1

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

• Data Hub 6.0 » 6.1

Procedure

1. Update the /your-project-root/build.gradle file.
   Important: Refer to the Backward Compatibility for Running Flows with Gradle section in the 6.0 tab to address automation issues.

   • In the plugins section, set com.marklogic.ml-data-hub to the new Data Hub version.

        plugins {
           // Gradle Properties plugin
           id 'net.saliman.properties' version '1.4.6'
     
           // Data Hub plugin
           id 'com.marklogic.ml-data-hub' version 'VERSION_NUMBER'
       }
     

     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.

   • In the dependencies section, change compile to implementation.
     Note: This step is only required if one of the following applies to your project:

     • you are upgrading from a project using Gradle 6.x. or earlier.
     • the build.gradle file already uses compile for dependencies.

     When upgrading from Gradle 6.x or earlier, use implementation for dependencies. Compile is not supported by Gradle 7.0 and later versions.

        dependencies {
           implementation "com.marklogic:marklogic-data-hub:VERSION_NUMBER"
       }
     

2. Update the /your-project-root/gradle/wrapper/gradle-wrapper.properties file.
   Note: This step is only required if you are upgrading from a project using Gradle 8.3 or earlier to 8.3 or later.

   Set distributionUrl to https\://services.gradle.org/distributions/gradle-8.3-bin.zip.

   distributionUrl=https\://services.gradle.org/distributions/gradle-8.3-bin.zip

3. 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.

   Unix systemsWindows
   ./gradlew hubUpdate -igradlew.bat hubUpdate -i
4. Run the Gradle task mlDeploy.
   Unix systemsWindows
   ./gradlew mlDeploy -igradlew.bat mlDeploy -i

Backward Compatibility for Running Flows with Gradle

Some users utilizing Gradle tasks to run flows may experience automation issues after upgrading to Data Hub 6.1.0. To maintain these automations, users must either modify their automation to use the Data Hub client jar or add the marklogic-data-hub-6.1.0-client.jar to their Gradle path.

To add the marklogic-data-hub-6.1.0-client.jar, follow these steps:

1. Download the marklogic-data-hub-6.1.0-client.jar.
2. Create a libs directory under the project root.
3. Copy the marklogic-data-hub-6.1.0-client.jar to the libs folder.
4. Update the /your-project-root/build.gradle file.

      buildscript {
      repositories {
      mavenCentral()
      // Add the client jar to the classpath by placing it in the libs directory
        fileTree(dir: 'libs', include: '*.jar').each { File file ->
          dependencies {
          classpath files(file) 
         }
        } 
       }    
      } 
      plugins {
        id 'net.saliman.properties' version '1.5.2'
        id 'com.marklogic.ml-data-hub' version '6.1.0'
        }
   
   
      // Testing for the presence of the client jar in the classpath
        task checkForClientJar() {
         doLast {
        Class.forName("com.marklogic.hub.clientjar.Main")
       }
      }
   		 

5. Refer to Step 2 of the Upgrade procedure listed above.

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

• Data Hub 5.8 » 6.1
• Data Hub 5.7 » 6.1
• Data Hub 5.6 » 6.1
• Data Hub 5.5 » 6.1
• Data Hub 5.4 » 6.1
• Data Hub 5.2 » 6.1
• Data Hub 5.1 » 6.1
• Data Hub 5.0 » 6.1

Procedure

1. Update the /your-project-root/build.gradle file.
   Important: Refer to the Backward Compatibility for Running Flows with Gradle section in the 6.0 tab to address automation issues.

   • In the plugins section, set com.marklogic.ml-data-hub to the new Data Hub version.

        plugins {
           // Gradle Properties plugin
           id 'net.saliman.properties' version '1.4.6'
     
           // Data Hub plugin
           id 'com.marklogic.ml-data-hub' version 'VERSION_NUMBER'
       }
     

     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.

   • In the dependencies section, change compile to implementation.
     Note: This step is only required if one of the following applies to your project:

     • you are upgrading from a project using Gradle 6.x. or earlier.
     • the build.gradle file already uses compile for dependencies.

     When upgrading from Gradle 6.x or earlier, use implementation for dependencies. Compile is not supported by Gradle 7.0 and later versions.

        dependencies {
           implementation "com.marklogic:marklogic-data-hub:VERSION_NUMBER"
       }
     

2. Update the /your-project-root/gradle/wrapper/gradle-wrapper.properties file.
   Note: This step is only required if you are upgrading from a project using Gradle 8.3 or earlier to 8.3 or later.

   Set distributionUrl to https\://services.gradle.org/distributions/gradle-8.3-bin.zip.

   distributionUrl=https\://services.gradle.org/distributions/gradle-8.3-bin.zip

3. 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.

   Unix systemsWindows
   ./gradlew hubUpdate -igradlew.bat hubUpdate -i
4. Update the gradle.properties file.
   • Delete the mlDHFVersion line.
   • (Recommended) To use the new Data Hub 5.2 default permissions for modules (data-hub-module-reader,read,data-hub-module-reader,execute,data-hub-module-writer,update,rest-extension-user,execute), delete mlModulePermissions.
5. Run the Gradle task mlDeploy.
   Unix systemsWindows
   ./gradlew mlDeploy -igradlew.bat mlDeploy -i
6. (Optional) If you intend to use Hub Central, convert your artifacts to the Hub Central format. If you do not plan to use Hub Central, the conversion is not required.