Add ST_Relate implementation using GEOS by Mehak3010 · Pull Request #691 · apache/sedona-db

Mehak3010 · 2026-03-06T18:29:53Z

This PR implements the ST_Relate function using the GEOS relate operation to compute the DE-9IM (Dimensionally Extended 9-Intersection Model) relationship between two geometries. The implementation integrates with the existing GEOS execution framework in Sedona and returns the resulting DE-9IM intersection matrix as a UTF-8 text string. The changes include adding the GEOS kernel implementation in sedona-geos, creating the corresponding scalar UDF wrapper in sedona-functions, and registering the function so it can be used through the SQL interface. This enables users to evaluate spatial relationships between geometries and obtain the DE-9IM matrix representation directly. This work addresses issue #539 and is part of the broader implementation tracked in #174.

petern48

I know you're still working on this, but I figured I'd leave a bit of hints to help guide you along the way.

petern48 · 2026-03-10T00:18:24Z

submodules/sedona-testing

It looks like you've deleted many files in the submodules, presumably accidentally. This is causing CI failures. Could you revert these deletions?

Don't be afraid to ask if you need help with figuring out how to undo this.

let me see... and will surely get back if some help is needed

petern48 · 2026-03-10T00:18:27Z

c/sedona-geos/src/st_relate.rs

+
+        executor.finish(Arc::new(builder.finish()))
+    }
+}


In addition to the actual rust implementation. We're going to need to add Rust tests in this file as well as python integration tests. You can take a look at this example PR (#288) to guide you if you'd like.

oki, let me check

We are still missing rust and python tests. Both of these are very important to have before we merge. The example PR has examples of these as well.

The rust tests should exist in this file, starting with:

#[cfg(test)] mod tests {

The new python tests for st_relate should go in test_predicates.py (since st_relate is a predicate). Make sure to read my comment (#288 (comment)) about how to iterate on developing Python integration tests

Thanks for the guidance! I’ll add the Rust tests in the module using #[cfg(test)] mod tests {} and implement the Python tests for st_relate in test_predicates.py, following the approach in #288.

…ions

…te added

Mehak3010 · 2026-03-11T14:15:23Z

Thanks for the suggestions! I have reverted the submodule changes and aligned the implementation with the structure used in PR #288 as recommended. All CI checks are now passing and the PR should be ready for review/merge.

petern48

Nice job. This is a good start. I've left some feedback. Mainly, we need to add tests.

rust/sedona-testing/src/data.rs

.gitignore

petern48 · 2026-03-12T01:43:41Z

rust/sedona-functions/src/register.rs

        crate::st_xyzm::st_y_udf,
        crate::st_xyzm::st_z_udf,
        crate::st_zmflag::st_zmflag_udf,
+        crate::st_relate::st_relate_udf,


nit: let's place this in alphabetical order too

petern48 · 2026-03-12T01:51:15Z

c/sedona-geos/src/st_relate.rs

+
+        executor.finish(Arc::new(builder.finish()))
+    }
+}


We are still missing rust and python tests. Both of these are very important to have before we merge. The example PR has examples of these as well.

The rust tests should exist in this file, starting with:

#[cfg(test)] mod tests {

The new python tests for st_relate should go in test_predicates.py (since st_relate is a predicate). Make sure to read my comment (#288 (comment)) about how to iterate on developing Python integration tests

… tests

petern48 · 2026-03-13T16:45:30Z

I noticed your recent commits fixing formatting.

I strongly suggest you set up the pre-commit hook in the linting section in the contributing guide. It's a one-time setup, and it will automatically format your code after each commit. This is a pretty standard tool you'll see in many repos. You shouldn't need to handle formatting nits manually.

I also updated the example PR to explicitly call this out, since I guess it's easy for people to not read through the entire contributing guide linked.

petern48 · 2026-03-13T16:50:56Z

python/sedonadb/tests/functions/test_predicates.py

-        f"SELECT ST_Overlaps({geom_or_null(geom1)}, {geom_or_null(geom2)})",
+        f"SELECT ST_Relate({geom_or_null(geom1)}, {geom_or_null(geom2)})",


Please don't delete existing tests. There should be no red diffs (deletions) in this file.

(sorry i know it's in draft, but I figured I'd call this out since I'm here anyways)

No issues at all, thank you for highlighting..

petern48 · 2026-03-13T17:09:11Z

Also you can ignore the packaging / docs-and-deploy CI failure. It seems like an unrelated failure that's showing up in other PRs as well

Mehak3010 · 2026-03-15T09:04:53Z

I’ve ensured that all 13 predicate functions are now present in test_predicates.py and that no existing tests were removed. All CI checks are passing now. The PR should be ready for further review, and I’m happy to address any additional feedback.

petern48

this is looking great! we're nearing there

rust/sedona-functions/src/lib.rs

petern48 · 2026-03-15T15:54:40Z

python/sedonadb/tests/functions/test_predicates.py

-        # These cases demonstrates the weirdness of ST_Contains:
-        # Both POINT(0 0) and GEOMETRYCOLLECTION (POINT (0 0)) contains POINT (0 0),
-        # but GEOMETRYCOLLECTION (POINT (0 0), LINESTRING (0 0, 1 1)) does not contain POINT (0 0).
-        # See https://lin-ear-th-inking.blogspot.com/2007/06/subtleties-of-ogc-covers-spatial.html


let's not delete this comment either.

petern48 · 2026-03-16T07:25:18Z

python/sedonadb/tests/functions/test_predicates.py

+            "POLYGON ((0 0, 2 0, 2 2, 0 2, 0 0))",
+            "POLYGON ((1 1, 3 1, 3 3, 1 3, 1 1))",
+            "212101212",
+        ),


I'd like to add some more edge cases. (We are usually more comprehensive for the Python tests, since they are very concise to write)

Could we add the following test cases? (These are just the inputs, you need to add the expected output values. I find the easiest way is to just run the tests, and copy-paste the outputs that come out. If both our sedonaDB implementation and PostGIS agree, we're good!)

If you come up with any other interesting edge cases, you're welcome to add them too.

("POINT (0 0)", "LINESTRING (0 0, 1 1)") ("LINESTRING (0 0, 2 2)", "LINESTRING (1 1, 3 3)") ("GEOMETRYCOLLECTION (POINT (0 0), LINESTRING (0 0,1 1))", "POINT (0 0)") ( "POLYGON ((0 0, 2 0, 2 2, 0 2, 0 0))", "POLYGON ((2 0, 4 0, 4 2, 2 2, 2 0))" ) # touching polygons ( "POLYGON ((0 0, 4 0, 4 4, 0 4, 0 0))", "POLYGON ((1 1, 2 1, 2 2, 1 2, 1 1))" ) # polygon containment ( "POLYGON ((0 0,6 0,6 6,0 6,0 0),(2 2,4 2,4 4,2 4,2 2))", "POINT (1 1)" ) # point in a polygon hole

Thanks for the suggestion! I’ll add these edge cases to the Python tests and determine the expected outputs by comparing SedonaDB and PostGIS results.

Co-authored-by: Peter Nguyen <petern0408@gmail.com>

petern48 reviewed Mar 10, 2026

View reviewed changes

Mehak3010 force-pushed the feat/st-relate-text branch from 6e098db to 760ac4c Compare March 10, 2026 14:29

mehakarora3010-dotcom added 8 commits March 10, 2026 20:19

Add ST_Relate implementation using GEOS

f0e8e3b

Apply rustfmt formatting fixes

1966baa

fix: implement ST_Relate returning DE-9IM string

1cfb7c9

fix: remove local cargo config and resolve clippy unused import

6233f5c

fix: resolve CI issues in ST_Relate

882377c

fix: handle missing register_geoarrow_extensions in newer DuckDB vers…

5096780

…ions

fix: ignore test_raster_resolves when assets are not downloaded

98d8047

fix: remove unintended submodule and config changes

c6623a4

Mehak3010 force-pushed the feat/st-relate-text branch from 43722df to c6623a4 Compare March 10, 2026 14:58

fix: restore lib.rs and register.rs to main branch state with st_rela…

cedfd67

…te added

Mehak3010 force-pushed the feat/st-relate-text branch from 718eb17 to cedfd67 Compare March 10, 2026 15:31

Mehak3010 marked this pull request as draft March 10, 2026 15:35

fix: correct st_relate module declaration

5136544

Mehak3010 marked this pull request as ready for review March 11, 2026 07:43

Mehak3010 marked this pull request as draft March 11, 2026 07:44

Mehak3010 force-pushed the feat/st-relate-text branch from 5dad3ab to 5136544 Compare March 11, 2026 07:54

mehakarora3010-dotcom added 2 commits March 11, 2026 13:41

feat: implement ST_Relate using GEOS

c0b1a02

feat(geos): implement ST_Relate using GEOS

c5f171e

Mehak3010 force-pushed the feat/st-relate-text branch from 357366b to c5f171e Compare March 11, 2026 08:23

fix: use for SedonaScalarUDF

9646893

Mehak3010 force-pushed the feat/st-relate-text branch from 5fc9681 to 9646893 Compare March 11, 2026 08:37

fix: rewrite st_relate_udf using SimpleSedonaScalarKernel pattern

40d256e

Mehak3010 force-pushed the feat/st-relate-text branch from c867b56 to 40d256e Compare March 11, 2026 08:49

fix: normalize trailing newline in st_relate.rs

4b467fc

Mehak3010 force-pushed the feat/st-relate-text branch from 1a330ef to 4b467fc Compare March 11, 2026 12:36

docs: add st_relate.qmd documentation file

156993f

Mehak3010 force-pushed the feat/st-relate-text branch from be0152e to 156993f Compare March 11, 2026 13:27

Mehak3010 marked this pull request as ready for review March 11, 2026 14:10

petern48 reviewed Mar 12, 2026

View reviewed changes

test: add Rust and Python tests for ST_Relate

64359d7

Mehak3010 force-pushed the feat/st-relate-text branch from bd9f15e to 64359d7 Compare March 12, 2026 17:46

fix: correct DE-9IM expected values in ST_Relate tests

e178a68

Mehak3010 force-pushed the feat/st-relate-text branch 2 times, most recently from 7f4b79d to e178a68 Compare March 12, 2026 19:28

mehakarora3010-dotcom and others added 2 commits March 13, 2026 01:02

fix: correct DE-9IM expected values and trailing newline in ST_Relate…

f609f38

… tests

Merge branch 'main' into feat/st-relate-text

89295ea

Mehak3010 marked this pull request as draft March 12, 2026 20:11

mehakarora3010-dotcom added 2 commits March 13, 2026 21:49

fix: add trailing newline to test_predicates.py

8a25cce

fix: trailing newline

0aed5ea

petern48 reviewed Mar 13, 2026

View reviewed changes

Mehak3010 marked this pull request as ready for review March 13, 2026 17:12

fix: restore tests in test_predicates.py

22c3761

petern48 reviewed Mar 16, 2026

View reviewed changes

Update rust/sedona-functions/src/lib.rs

6dc2a3d

Co-authored-by: Peter Nguyen <petern0408@gmail.com>

		f"SELECT ST_Overlaps({geom_or_null(geom1)}, {geom_or_null(geom2)})",
		f"SELECT ST_Relate({geom_or_null(geom1)}, {geom_or_null(geom2)})",

Conversation

Mehak3010 commented Mar 6, 2026

Uh oh!

petern48 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Mehak3010 Mar 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Mehak3010 commented Mar 11, 2026

Uh oh!

petern48 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

petern48 commented Mar 13, 2026

Uh oh!

petern48 Mar 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Mehak3010 Mar 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

petern48 commented Mar 13, 2026

Uh oh!

Mehak3010 commented Mar 15, 2026

Uh oh!

petern48 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Mehak3010 Mar 12, 2026 •

edited

Loading

petern48 left a comment •

edited

Loading

petern48 Mar 13, 2026 •

edited

Loading

Mehak3010 Mar 13, 2026 •

edited

Loading