Skip to content

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

Latest commit

 

History

History
67 lines (51 loc) · 2.48 KB

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

File metadata and controls

67 lines (51 loc) · 2.48 KB
title sp_help_spatial_geography_index (Transact-SQL)
description Returns the names and values for a specified set of properties about a geography spatial index.
author markingmyname
ms.author maghan
ms.reviewer randolphwest
ms.date 06/23/2025
ms.service sql
ms.subservice system-objects
ms.topic reference
f1_keywords
sp_help_spatial_geography_index
sp_help_spatial_geography_index_TSQL
helpviewer_keywords
sp_help_spatial_geography_index procedure
dev_langs
TSQL

sp_help_spatial_geography_index (Transact-SQL)

[!INCLUDE SQL Server]

Returns the names and values for a specified set of properties about a geography 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_geography_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.

Examples

The following example uses sp_help_spatial_geography_index to investigate the geography spatial index SIndx_SpatialTable_geography_col2 defined on table geography_col for the given query sample in @qs. This example returns only the core properties of the specified index.

DECLARE @qs AS GEOGRAPHY = 'POLYGON((-90.0 -180, -90 180.0, 90 180.0, 90 -180, -90 -180.0))';

EXECUTE sp_help_spatial_geography_index
    'geography_col',
    'SIndx_SpatialTable_geography_col2',
    0,
    @qs;

The bounding box of a geography instance is the whole earth.

Related content