STContains (geometry Data Type)

THIS TOPIC APPLIES TO:yesSQL Server (starting with 2012)noAzure SQL DatabaseyesAzure SQL Data Warehouse noParallel Data Warehouse

Returns 1 if a geometry instance completely contains another geometry instance. Returns 0 if it does not.

||
|-|
|Applies to: SQL Server ( SQL Server 2012 through current version), Azure SQL Database .|

Syntax


.STContains ( other_geometry )  

Arguments

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

Return Types

SQL Server return type: bit

CLR return type: SqlBoolean

Remarks

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

Examples

The following example uses STContains() to test two geometry instances to see if the first instance contains 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('POINT(1 1)', 0);  
SELECT @g.STContains(@h);  

See Also

Spatial Indexes Overview
OGC Methods on Geometry Instances