Available in versions: Dev (3.20) | Latest (3.19) | 3.18 | 3.17 | 3.16

This documentation is for the unreleased development version of jOOQ. Click on the above version links to get this documentation for a supported version of jOOQ.

ST_Within

Applies to ❌ Open Source Edition   ✅ Express Edition   ✅ Professional Edition   ✅ Enterprise Edition

This predicate checks if one geometry is within another. This is the inverse of ST_Contains. For example:

create.select(
  field(stWithin(
    stGeomFromText("POINT (-2 0)"),
    stGeomFromText("POLYGON ((-3 -1, -1 -1, -1 1, -3 1, -3 -1))")
  )),
  field(stWithin(
    stGeomFromText("POINT (4 0)"),
    stGeomFromText("POLYGON ((3 -1, 1 -1, 1 1, 3 1, 3 -1))")
  ))
).fetch();

The result being, for example

+-----------+-----------+
| ST_Within | ST_Within |
+-----------+-----------+
| true      | false     |
+-----------+-----------+

Or, visually:










Dialect support

This example using jOOQ:

stWithin(geometry1, geometry2)

Translates to the following dialect specific expressions:

Aurora MySQL, Aurora Postgres, CockroachDB, MariaDB, MySQL, Postgres, Redshift, Snowflake

st_within(geometry1, geometry2)

Oracle

((sdo_inside(geometry1, geometry2) = 'TRUE'))

SQLServer

geometry1.STWithin(geometry2) = 1

ASE, Access, BigQuery, DB2, Derby, DuckDB, Exasol, Firebird, H2, HSQLDB, Hana, Informix, MemSQL, SQLDataWarehouse, SQLite, Sybase, Teradata, Trino, Vertica, YugabyteDB

/* UNSUPPORTED */

(These are currently generated with jOOQ 3.20, see #10141), or translate your own on our website

References to this page

Feedback

Do you have any feedback about this page? We'd love to hear it!

The jOOQ Logo