Skip to content

Latest commit

 

History

History
69 lines (52 loc) · 2.48 KB

sp-help-spatial-geometry-index-transact-sql.md

File metadata and controls

69 lines (52 loc) · 2.48 KB
title description author ms.author ms.reviewer ms.date ms.service ms.subservice ms.topic f1_keywords helpviewer_keywords dev_langs
sp_help_spatial_geometry_index (Transact-SQL)
Returns the names and values for a specified set of properties about a geometry spatial index.
markingmyname
maghan
randolphwest
05/14/2024
sql
system-objects
reference
sp_help_spatial_geometry_index
sp_help_spatial_geometry_index_TSQL
sp_help_spatial_geometry_index procedure
TSQL

sp_help_spatial_geometry_index (Transact-SQL)

[!INCLUDE 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.

:::image type="icon" source="../../includes/media/topic-link-icon.svg" border="false"::: Transact-SQL syntax conventions

Syntax

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

Arguments and properties

See Spatial index stored procedures - arguments and properties.

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 aren't included in the return set.

Examples

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;

Related content