sp_help_spatial_geometry_index (Transact-SQL)

Article
02/28/2023

Applies to: SQL Server

Returns the names and values for a specified set of properties about a geometry spatial index. The result is returned in a table format. You can choose to return a core set of properties or all properties of the index.

Transact-SQL syntax conventions

Syntax

  
sp_help_spatial_geometry_index [ @tabname =] 'tabname'   
     [ , [ @indexname = ] 'indexname' ]   
     [ , [ @verboseoutput = ] 'verboseoutput'   
     [ , [ @query_sample = ] 'query_sample']

Arguments

See Arguments and Properties of Spatial Index Stored Procedures.

Property Value/Return Value

See Arguments and Properties of Spatial Index Stored Procedures.

Permissions

User must be assigned a PUBLIC role to access the procedure. Requires READ ACCESS permission on the server and the object.

Remarks

Properties containing NULL values are not included in the return set.

Example

The following example uses sp_help_spatial_geometry_index to investigate the spatial index SIndx_SpatialTable_geometry_col2 defined on table geometry_col for the given query sample in @qs. This example returns only the core properties of the specified index.

declare @qs geometry  
        ='POLYGON((-90.0 -180.0, -90.0 180.0, 90.0 180.0, 90.0 -180.0, -90.0 -180.0))';  
exec sp_help_spatial_geometry_index 'geometry_col', 'SIndx_SpatialTable_geometry_col2', 0, @qs;