Skip to content

Latest commit

 

History

History
83 lines (61 loc) · 3.31 KB

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

File metadata and controls

83 lines (61 loc) · 3.31 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_geography_index_xml (Transact-SQL)
Returns the name and value for a specified set of properties about a geography spatial index.
markingmyname
maghan
randolphwest
05/14/2024
sql
system-objects
reference
sp_help_spatial_geography_index_xml_TSQL
sp_help_spatial_geography_index_xml
sp_help_spatial_geography_index_xml procedure
TSQL

sp_help_spatial_geography_index_xml (Transact-SQL)

[!INCLUDE SQL Server]

Returns the name and value for a specified set of properties about a geography spatial index. You can choose to return a core set of properties or all properties of the index.

Results are returned in an XML fragment that displays the name and value of the properties selected.

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

Syntax

sp_help_spatial_geography_index_xml
    [ @tabname = ] N'tabname'
    , [ @indexname = ] N'indexname'
    , [ @verboseoutput = ] verboseoutput
    , [ @query_sample = ] query_sample
    , [ @xml_output = ] N'xml_output' OUTPUT
[ ; ]

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_geography_index_xml to investigate the spatial index SIndx_SpatialTable_geography_col2 defined on table geography_col for the given query sample in @qs. This example returns the core properties of the specified index in an XML fragment that displays the name and value of the properties selected.

An XQuery is then run on the result set, returning a specific property.

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

EXEC sp_help_spatial_geography_index_xml 'geography_col',
    'SIndx_SpatialTable_geography_col2',
    0,
    @qs,
    @x OUTPUT;

SELECT @x.value('(/Primary_Filter_Efficiency/text())[1]', 'float');

Similar to sp_help_spatial_geography_index, this stored procedure provides simpler programmatic access to the properties of a geography spatial index and reports the result set in XML.

The bounding box of a geography is the whole earth.

Related content