Skip to content

Latest commit

 

History

History
81 lines (60 loc) · 3.26 KB

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

File metadata and controls

81 lines (60 loc) · 3.26 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_xml (Transact-SQL)
sp_help_spatial_geometry_index_xml 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_xml_TSQL
sp_help_spatial_geometry_index_xml
sp_help_spatial_geometry_index_xml procedure
TSQL

sp_help_spatial_geometry_index_xml (Transact-SQL)

[!INCLUDE SQL Server]

Returns the names and values for a specified set of properties about a geometry 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_geometry_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 a member of the public role. Requires READ ACCESS permission on the server and the object.

Remarks

Properties containing NULL values aren't included in the XML return set.

Examples

The following example uses sp_help_spatial_geometry_index_xml to investigate the spatial index SIndx_SpatialTable_geometry_col2 defined on table geometry_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 Basics is then run on the result set, returning a specific property.

DECLARE @qs geometry = 'POLYGON((-90.0 -180.0, -90.0 180.0, 90.0 180.0, 90.0 -180.0, -90.0 -180.0))';
DECLARE @x XML;

EXEC sp_help_spatial_geometry_index_xml 'geometry_col',
    'SIndx_SpatialTable_geometry_col2',
    0,
    @qs,
    @x OUTPUT;

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

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

Related content