Skip to content

Commit 3663173

Browse files
authored
Merge pull request #79 from marklogic/feature/notebook-example
Added Jupyter notebook and some more doc tweaks
2 parents 12c1d54 + 96cc373 commit 3663173

File tree

3 files changed

+290
-2
lines changed

3 files changed

+290
-2
lines changed

docs/getting-started/jupyter.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,5 +46,10 @@ jar on your filesystem. You are free to customize the `spark` variable in any ma
4646
Now that you have an initialized Spark session, you can run any of the examples found in the
4747
[guide for using PySpark](pyspark.md).
4848

49+
## Example notebook
4950

50-
51+
The [getting-started example project](https://github.com/marklogic/marklogic-spark-connector/tree/master/examples/getting-started)
52+
includes an
53+
[example notebook](https://github.com/marklogic/marklogic-spark-connector/tree/master/examples/getting-started/marklogic-spark-getting-started.ipynb)
54+
that you can open in Jupyter Notebook. This allows you to try a few examples with a working notebook without having to
55+
enter anything in.

docs/index.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,10 @@ nav_order: 1
55
---
66

77
The MarkLogic Spark connector is an [Apache Spark 3 connector](https://spark.apache.org/docs/latest/) that supports
8-
reading data from and writing data to MarkLogic.
8+
reading data from and writing data to MarkLogic. Within any Spark 3 environment, the connector enables users to easily
9+
query for data in MarkLogic, manipulate it using widely-known Spark operations, and then write results back to
10+
MarkLogic or disseminate them to another system. Data can also be easily imported into MarkLogic by first reading it
11+
from any data source that Spark supports and then writing it to MarkLogic.
912

1013
The connector has the following system requirements:
1114

examples/getting-started/marklogic-spark-getting-started.ipynb

Lines changed: 280 additions & 0 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)