Skip to content
This repository has been archived by the owner on Feb 27, 2023. It is now read-only.

Write batch processing applications in MarkLogic

License

Unknown, Unknown licenses found

Licenses found

Unknown
LICENSE.md
Unknown
LICENSE.txt
Notifications You must be signed in to change notification settings

marklogic-community/marklogic-spring-batch

Repository files navigation

GitHub version

Branch Status
master master
dev dev

MarkLogic Spring Batch

The MarkLogic Spring Batch project is an extension of the CORE and INFRASTRUCTURE components of Spring Batch to make it easier to write batch processing programs using MarkLogic.

Start with the project home page to get started.

Prerequisites

  • MarkLogic 8+
  • JDK 1.8+

Installing the Test Environment

Open $PROJECT_ROOT/gradle.properties. Review the mlHost, mlRestPort, mlJobRepoPort properties to confirm there are no conflicts

gradlew mlDeploy

This command will set up your test database and application server.

Running the tests

Review the host/port/user credentials properties for the following property files.

  • ./core/src/test/resources/job.properties
  • ./infrastructure/src/test/resources/job.properties
  • ./rdf/src/test/resources/job.properties
  • ./samples/src/test/resources/job.properties

Run the following command to execute all project tests. All tests should pass.

 gradlew test

Coding Style Tests

This project uses both checkstyle and PMD.

 gradlew check

Deployment

The product of this project are jar files that are published to bintray. The following libraries are created.

Group Artifact
com.marklogic marklogic-spring-batch-core
com.marklogic marklogic-spring-batch-test
com.marklogic spring-batch-http
com.marklogic spring-batch-rdbms
com.marklogic spring-batch-file

The gradle bintray plugin is used to publish to bintray.

 gradlew :core:bintrayUpload
 gradlew :file:bintrayUpload
 gradlew :test:bintrayUpload
 gradlew :http:bintrayUpload
 gradlew :rdbms:bintrayUpload

How do I use these libraries?

Gradle

dependencies {
    compile 'com.marklogic:marklogic-spring-batch-core:1.+'
    testCompile 'com.marklogic:marklogic-spring-batch-test:1.+'
}

Maven

<dependencies>
    <dependency>
        <groupId>com.marklogic</groupId>
        <artifactId>marklogic-spring-batch-core</artifactId>
        <version>1.5.0</version>
    </dependency>
</dependencies>

How can I contribute to the project?

Please read CONTRIBUTING.md for details on how to contribute code to this project and the process for submitting pull requests to us.

What license does MarkLogic Spring Batch use?

See the LICENSE.md file for details