Skip to content

Commit ff696cc

Browse files
rjrudinMarkLogic Builder
authored andcommitted
DHFPROD-7571: Improvements to Spark README
1 parent 8452b5d commit ff696cc

File tree

1 file changed

+15
-6
lines changed

1 file changed

+15
-6
lines changed

marklogic-data-hub-spark-connector/README.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,16 @@
1-
h2. Building and testing the connector jar
1+
# MarkLogic Connector for Apache Spark
2+
3+
This project contains the software for the MarkLogic connector for Spark. Please see
4+
[the documentation](https://docs.marklogic.com/cloudservices/aws/admin/dhs-tools.html) and
5+
[the tutorial](https://developer.marklogic.com/learn/spark/) for information on using the connector in
6+
an AWS Glue environment. The rest of this README provides instructions for building and testing the connector locally.
7+
8+
Note that this connector is part of the Data Hub Framework project. This is due to its dependency on a few DHF library
9+
modules. It is possible to remove this dependency by configuring the connector to use your own endpoint modules.
10+
[The connector documentation](https://docs.marklogic.com/cloudservices/aws/admin/dhs-tools.html) provides information
11+
on the connector options for using your own endpoint modules.
12+
13+
## Building and testing the connector jar
214

315
To build the connector, run:
416

@@ -10,15 +22,12 @@ included in a Spark environment.
1022
An example of such an environment is in the ./spark-test-project directory. Please see the README file in that directory
1123
for instructions on how to test the connector jar within that project.
1224

13-
h2. Running the connector tests
25+
## Running the connector tests
1426

15-
To run the automated tests for this project, run:
27+
If you are working on enhancements to this project, you'll likely want to run the automated tests for it. To do so, run:
1628

1729
../gradlew test
1830

1931
Note that if you would like to run the tests in an IDE like Intellij, you must first run the Gradle task
2032
"copyConnectorModulesFromCoreProject" so that the connector modules, which live in the ./marklogic-data-hub project,
2133
are available to be loaded by the tests. Running "test" will do this for you automatically.
22-
23-
24-

0 commit comments

Comments
 (0)