STV_Describe_Index

检索关于包含一组多边形的索引的信息。如果没有传递任何参数，STV_Describe_Index 将返回所有已定义的索引。

OVER() 子句必须为空。

行为类型

不可变

语法

STV_Describe_Index ( [ USING PARAMETERS [index='index_name']
                                        [, list_polygons={true | false } ]] ) OVER ()

实参

index = 'index_name'
索引的名称，类型为 VARCHAR。索引名称不能超过 110 个字符。索引名称中不允许使用斜杠、反斜杠和制表符。
list_polygon
（可选）用于指定是否列出索引中的多边形的 BOOLEAN 值。索引参数必须与此参数配合使用。

返回

polygons
已编制索引的多边形数量。
SRID
空间参照系标识符。
min_x, min_y, max_x, max_y
已编制索引的几何图形的最小边界矩形 (MBR) 的坐标。(min_x, min_y) 是西南坐标，(max_x, max_y) 是东北坐标。
name
空间索引的名称。
gid
唯一标识多边形的 Integer 列的名称。Gid 不能为 NULL。
state
索引中的空间对象的状态。可能的值为：

  • INDEXED - 空间对象已成功编制索引。

  • SELF_INTERSECT -（仅限 WGS84）空间对象未编制索引，因为其一个边与自身的另一个边相交。

  • EDGE_CROSS_IDL -（仅限 WGS84）空间对象未编制索引，因为其一个边与国际日期变更线交叉。

  • EDGE_HALF_CIRCLE -（仅限 WGS84）空间对象未编制索引，因为包含两个对跖的相邻顶点。

  • NON_INDEXABLE - 空间对象无法编制索引。

geography

空间对象的熟知二进制 (WKB) 表示。

geometry

空间对象的熟知二进制 (WKB) 表示。

特权

任何有权访问 STV_*_Index 函数的用户都可以描述、重命名或删除由其他任何用户创建的索引。

限制

如果索引是使用 12.0.x 或更早版本创建的，一些功能将会要求重建索引。

示例

以下示例显示了 STV_Describe_Index 的用法。

检索关于索引的信息：

=> SELECT STV_Describe_Index (USING PARAMETERS index='my_polygons') OVER ();
   type   | polygons | SRID | min_x | min_y | max_x | max_y
----------+----------+------+-------+-------+-------+-------
 GEOMETRY |        4 |    0 |    -1 |    -1 |    12 |    12


(1 row)

返回所有已定义的索引的名称：

=> SELECT STV_Describe_Index() OVER ();
       name
------------------
MA_counties_index
my_polygons
NY_counties_index
US_States_Index
(4 rows)

返回索引中包含的多边形：

=> SELECT STV_Describe_Index(USING PARAMETERS index='my_polygons', list_polygons=TRUE) OVER ();
 gid |     state     |            geometry
-----+---------------+----------------------------------
  12 | INDEXED       | \260\000\000\000\000\000\000\ ...
  14 | INDEXED       | \200\000\000\000\000\000\000\ ...
  10 | NON_INDEXABLE | \274\000\000\000\000\000\000\ ...
  11 | INDEXED       | \260\000\000\000\000\000\000\ ...
(4 rows)

另请参阅