add note about setting checkpoint dir for DBSCAN

apache · Jan 7, 2025 · 09c22bf · 09c22bf
1 parent af74a17
commit 09c22bf
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/docs/tutorial/sql.md b/docs/tutorial/sql.md
@@ -858,6 +858,11 @@ The algorithm is available as a Scala and Python function called on a spatial da
 
 The first parameter is the dataframe, the next two are the epsilon and min_points parameters of the DBSCAN algorithm.
 
+!!!Note
+The sparkContext's checkpoint directory must be set to use DBSCAN. Sedona's DBSCAN implementation uses Graphframes
+which requires a checkpoint directory to be set. This can be done by calling `sparkContext.setCheckpointDir("path/to/checkpoint")`.
+
+
 === "Scala"
 
 	```scala