st_within function
Applies to: 
Databricks Runtime 17.1 and above
Preview
This feature is in Public Preview.
Returns true if the first GEOMETRY is within the second GEOMETRY.
Syntax
st_within ( geo1, geo2 )
Arguments
geo1: The firstGEOMETRYvalue.geo2: The secondGEOMETRYvalue.
Returns
A value of type BOOLEAN, true if the first geometry is within the second geometry.
The function returns NULL if any of the inputs is NULL.
Error conditions
- If any of the input geometries is a geometry collection, the function returns ST_INVALID_ARGUMENT_TYPE.
- If the input geometries do not have the same SRID value, the function returns ST_DIFFERENT_SRID_VALUES.
Examples
SQL
-- Returns true when point is within polygon.
> SELECT st_within(st_geomfromtext('POINT(1 1)'),st_geomfromtext('POLYGON((0 0,10 0,0 10,0 0))'));
true
-- Returns false when point is on boundary.
> SELECT st_within(st_geomfromtext('POINT(5 0)'),st_geomfromtext('POLYGON((0 0,10 0,0 10,0 0))'));
false
-- Returns false when point is outside polygon.
> SELECT st_within(st_geomfromtext('POINT(5 6)'),st_geomfromtext('POLYGON((0 0,10 0,0 10,0 0))'));
false