Skip to content

Latest commit

 

History

History
60 lines (47 loc) · 1.9 KB

stwithin-geometry-data-type.md

File metadata and controls

60 lines (47 loc) · 1.9 KB
title description author ms.author ms.date ms.service ms.subservice ms.topic ms.custom f1_keywords helpviewer_keywords dev_langs monikerRange
STWithin (geometry Data Type)
STWithin (geometry Data Type)
MladjoA
mlandzic
08/03/2017
sql
t-sql
reference
ignite-2024
STWithin_TSQL
STWithin (geometry Data Type)
STWithin (geometry Data Type)
TSQL
=azuresqldb-current || >=sql-server-2016 || >=sql-server-linux-2017 || =azuresqldb-mi-current || =fabric

STWithin (geometry Data Type)

[!INCLUDE SQL Server Azure SQL Database Azure SQL Managed Instance FabricSQLDB]

Returns 1 if a geometry instance is completely within another geometry instance; otherwise, returns 0. The STWithin command is case-sensitive.

Syntax

  
.STWithin ( other_geometry )  

Arguments

other_geometry
Is another geometry instance to compare against the instance on which STWithin() is invoked.

Return Types

[!INCLUDEssNoVersion] return type: bit

CLR return type: SqlBoolean

Remarks

This method always returns null if the spatial reference IDs (SRIDs) of the geometry instances do not match.

Examples

The following example uses STWithin() to test two geometry instances to see if the first instance is completely within the second instance.

DECLARE @g geometry;  
DECLARE @h geometry;  
SET @g = geometry::STGeomFromText('POLYGON((0 0, 2 0, 2 2, 0 2, 0 0))', 0);  
SET @h = geometry::STGeomFromText('POLYGON((1 1, 3 1, 3 3, 1 3, 1 1))', 0);  
SELECT @g.STWithin(@h);  

See Also

Spatial Indexes Overview
OGC Methods on Geometry Instances