1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325
|
<!-- Converted by db4-upgrade version 1.1 -->
<section xmlns:xlink="http://www.w3.org/1999/xlink" xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="Geometry_Accessors">
<title>Geometry Accessors</title>
<refentry xml:id="GeometryType">
<refnamediv>
<refname>GeometryType</refname>
<refpurpose>Returns the type of a geometry as text.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>text <function>GeometryType</function></funcdef>
<paramdef><type>geometry </type> <parameter>geomA</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Returns the type of the geometry as a string. Eg:
'LINESTRING', 'POLYGON', 'MULTIPOINT', etc.</para>
<para>OGC SPEC s2.1.1.1 - Returns the name of the instantiable
subtype of Geometry of which this Geometry instance is a member.
The name of the instantiable subtype of Geometry is returned as a
string.</para>
<note>
<para>This function also indicates if the geometry is measured,
by returning a string of the form 'POINTM'.</para>
</note>
<para role="enhanced" conformance="2.0.0">Enhanced: 2.0.0 support for Polyhedral surfaces, Triangles and TIN was introduced.</para>
<para>&sfs_compliant;</para>
<para>&curve_support;</para>
<para>&Z_support;</para>
<para>&P_support;</para>
<para>&T_support;</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>SELECT GeometryType(ST_GeomFromText('LINESTRING(77.29 29.07,77.42 29.26,77.27 29.31,77.29 29.07)'));
geometrytype
--------------
LINESTRING
</programlisting>
<programlisting>SELECT ST_GeometryType(ST_GeomFromEWKT('POLYHEDRALSURFACE( ((0 0 0, 0 0 1, 0 1 1, 0 1 0, 0 0 0)),
((0 0 0, 0 1 0, 1 1 0, 1 0 0, 0 0 0)), ((0 0 0, 1 0 0, 1 0 1, 0 0 1, 0 0 0)),
((1 1 0, 1 1 1, 1 0 1, 1 0 0, 1 1 0)),
((0 1 0, 0 1 1, 1 1 1, 1 1 0, 0 1 0)), ((0 0 1, 1 0 1, 1 1 1, 0 1 1, 0 0 1)) )'));
--result
POLYHEDRALSURFACE
</programlisting>
<programlisting>SELECT GeometryType(geom) as result
FROM
(SELECT
ST_GeomFromEWKT('TIN (((
0 0 0,
0 0 1,
0 1 0,
0 0 0
)), ((
0 0 0,
0 1 0,
1 1 0,
0 0 0
))
)') AS geom
) AS g;
result
--------
TIN </programlisting>
</refsection>
<!-- Optionally add a "See Also" section -->
<refsection>
<title>See Also</title>
<para><xref linkend="ST_GeometryType"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_Boundary">
<refnamediv>
<refname>ST_Boundary</refname>
<refpurpose>Returns the boundary of a geometry.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_Boundary</function></funcdef>
<paramdef><type>geometry </type> <parameter>geomA</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Returns the closure of the combinatorial boundary of this
Geometry. The combinatorial boundary is defined as described in
section 3.12.3.2 of the OGC SPEC. Because the result of this
function is a closure, and hence topologically closed, the
resulting boundary can be represented using representational
geometry primitives as discussed in the OGC SPEC, section
3.12.2.</para>
<para>Performed by the GEOS module</para>
<note> <para>Prior to 2.0.0, this function throws an exception if used with <varname>GEOMETRYCOLLECTION</varname>. From 2.0.0 up it will return NULL instead (unsupported input).</para></note>
<para>&sfs_compliant; OGC SPEC s2.1.1.1</para>
<para>&sqlmm_compliant; SQL-MM IEC 13249-3: 5.1.17</para>
<para>&Z_support;</para>
<para role="enhanced" conformance="2.1.0">Enhanced: 2.1.0 support for Triangle was introduced</para>
<para role="changed" conformance="3.2.0">Changed: 3.2.0 support for TIN, does not use geos, does not linearize curves</para>
</refsection>
<refsection>
<title>Examples</title>
<informaltable>
<tgroup cols="2">
<tbody>
<row>
<entry><para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_boundary01.png"/>
</imageobject>
<caption><para>Linestring with boundary points overlaid</para></caption>
</mediaobject>
</informalfigure>
<programlisting>SELECT ST_Boundary(geom)
FROM (SELECT 'LINESTRING(100 150,50 60, 70 80, 160 170)'::geometry As geom) As f;
</programlisting>
<screen>
<lineannotation>
ST_AsText output
</lineannotation>
MULTIPOINT((100 150),(160 170))
</screen>
</para></entry>
<entry><para><informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_boundary02.png"/>
</imageobject>
<caption><para>polygon holes with boundary multilinestring</para></caption>
</mediaobject>
</informalfigure>
<programlisting>SELECT ST_Boundary(geom)
FROM (SELECT
'POLYGON (( 10 130, 50 190, 110 190, 140 150, 150 80, 100 10, 20 40, 10 130 ),
( 70 40, 100 50, 120 80, 80 110, 50 90, 70 40 ))'::geometry As geom) As f;
</programlisting>
<screen>
<lineannotation>
ST_AsText output
</lineannotation>
MULTILINESTRING((10 130,50 190,110 190,140 150,150 80,100 10,20 40,10 130),
(70 40,100 50,120 80,80 110,50 90,70 40))
</screen>
</para></entry>
</row>
</tbody>
</tgroup>
</informaltable>
<programlisting>SELECT ST_AsText(ST_Boundary(ST_GeomFromText('LINESTRING(1 1,0 0, -1 1)')));
st_astext
-----------
MULTIPOINT((1 1),(-1 1))
SELECT ST_AsText(ST_Boundary(ST_GeomFromText('POLYGON((1 1,0 0, -1 1, 1 1))')));
st_astext
----------
LINESTRING(1 1,0 0,-1 1,1 1)
--Using a 3d polygon
SELECT ST_AsEWKT(ST_Boundary(ST_GeomFromEWKT('POLYGON((1 1 1,0 0 1, -1 1 1, 1 1 1))')));
st_asewkt
-----------------------------------
LINESTRING(1 1 1,0 0 1,-1 1 1,1 1 1)
--Using a 3d multilinestring
SELECT ST_AsEWKT(ST_Boundary(ST_GeomFromEWKT('MULTILINESTRING((1 1 1,0 0 0.5, -1 1 1),(1 1 0.5,0 0 0.5, -1 1 0.5, 1 1 0.5) )')));
st_asewkt
----------
MULTIPOINT((-1 1 1),(1 1 0.75))
</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_AsText"/>, <xref linkend="ST_ExteriorRing"/>, <xref linkend="ST_MakePolygon"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_BoundingDiagonal">
<refnamediv>
<refname>ST_BoundingDiagonal</refname>
<refpurpose>Returns the diagonal of a geometry's bounding box.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_BoundingDiagonal</function></funcdef>
<paramdef><type>geometry </type> <parameter>geom</parameter></paramdef>
<paramdef choice="opt"><type>boolean </type> <parameter>fits=false</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>
Returns the diagonal of the supplied geometry's bounding box as a LineString.
The diagonal is a 2-point LineString with the minimum values of each dimension in its
start point and the maximum values in its end point.
If the input geometry is empty, the diagonal line is a LINESTRING EMPTY.
</para>
<para>
The optional <varname>fits</varname> parameter specifies if the best fit is needed.
If false, the diagonal of a somewhat larger bounding box can be accepted
(which is faster to compute for geometries with many vertices). In either case,
the bounding box of the returned diagonal line always covers the input
geometry.
</para>
<para>
The returned geometry retains the SRID and dimensionality
(Z and M presence) of the input geometry.
</para>
<note><para>
In degenerate cases (i.e. a single vertex in input) the returned linestring
will be formally invalid (no interior).
The result is still topologically valid.
</para></note>
<para role="availability" conformance="2.2.0">Availability: 2.2.0</para>
<para>&Z_support;</para>
<para>&M_support;</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>
-- Get the minimum X in a buffer around a point
SELECT ST_X(ST_StartPoint(ST_BoundingDiagonal(
ST_Buffer(ST_Point(0,0),10)
)));
st_x
------
-10
</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para>
<xref linkend="ST_StartPoint"/>,
<xref linkend="ST_EndPoint"/>,
<xref linkend="ST_X"/>,
<xref linkend="ST_Y"/>,
<xref linkend="ST_Z"/>,
<xref linkend="ST_M"/>,
<xref linkend="ST_Envelope"/>
</para>
</refsection>
</refentry>
<refentry xml:id="ST_CoordDim">
<refnamediv>
<refname>ST_CoordDim</refname>
<refpurpose>Return the coordinate dimension of a geometry.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>integer <function>ST_CoordDim</function></funcdef>
<paramdef><type>geometry </type> <parameter>geomA</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Return the coordinate dimension of the ST_Geometry value.</para>
<para>This is the MM compliant alias name for <xref linkend="ST_NDims"/></para>
<para>&sfs_compliant;</para>
<para>&sqlmm_compliant; SQL-MM 3: 5.1.3</para>
<para>&curve_support;</para>
<para>&Z_support;</para>
<para>&P_support;</para>
<para>&T_support;</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>SELECT ST_CoordDim('CIRCULARSTRING(1 2 3, 1 3 4, 5 6 7, 8 9 10, 11 12 13)');
---result--
3
SELECT ST_CoordDim(ST_Point(1,2));
--result--
2
</programlisting>
</refsection>
<!-- Optionally add a "See Also" section -->
<refsection>
<title>See Also</title>
<para><xref linkend="ST_NDims"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_Dimension">
<refnamediv>
<refname>ST_Dimension</refname>
<refpurpose>Returns the topological dimension of a geometry. </refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>integer <function>ST_Dimension</function></funcdef>
<paramdef><type>geometry </type> <parameter>g</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Return the topological dimension of this Geometry object, which must
be less than or equal to the coordinate dimension. OGC SPEC
s2.1.1.1 - returns 0 for <varname>POINT</varname>, 1 for <varname>LINESTRING</varname>, 2 for <varname>POLYGON</varname>, and
the largest dimension of the components of a
<varname>GEOMETRYCOLLECTION</varname>.
If the dimension is unknown (e.g. for an empty <varname>GEOMETRYCOLLECTION</varname>) 0 is returned.
</para>
<para>&sqlmm_compliant; SQL-MM 3: 5.1.2</para>
<para role="enhanced" conformance="2.0.0">Enhanced: 2.0.0 support for Polyhedral surfaces and TINs was introduced. No longer throws an exception if given empty geometry.</para>
<note> <para>Prior to 2.0.0, this function throws an exception if used with empty geometry. </para></note>
<para>&P_support;</para>
<para>&T_support;</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>SELECT ST_Dimension('GEOMETRYCOLLECTION(LINESTRING(1 1,0 0),POINT(0 0))');
ST_Dimension
-----------
1
</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_NDims"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_Dump">
<refnamediv>
<refname>ST_Dump</refname>
<refpurpose>Returns a set of <varname>geometry_dump</varname> rows for the components of a geometry.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry_dump[] <function>ST_Dump</function></funcdef>
<paramdef><type>geometry </type> <parameter>g1</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>A set-returning function (SRF) that extracts the components of a geometry.
It returns a set of
<xref linkend="geometry_dump"/> rows,
each containing a geometry (<parameter>geom</parameter> field)
and an array of integers (<parameter>path</parameter> field).
</para>
<para>For an atomic geometry type
(POINT,LINESTRING,POLYGON) a single record is returned with
an empty <parameter>path</parameter> array and the input geometry as <parameter>geom</parameter>.
For a collection or multi-geometry a record is returned for each
of the collection components, and the <parameter>path</parameter> denotes the
position of the component inside the collection.</para>
<para>ST_Dump is useful for expanding geometries. It is the
inverse of a <xref linkend="ST_Collect"/> / GROUP BY, in that it creates new rows.
For example it can be use to expand MULTIPOLYGONS into POLYGONS.</para>
<para role="enhanced" conformance="2.0.0">Enhanced: 2.0.0 support for Polyhedral surfaces, Triangles and TIN was introduced.</para>
<para role="availability" conformance="1.0.0">Availability: PostGIS 1.0.0RC1. Requires PostgreSQL 7.3 or higher.</para>
<note><para>Prior to 1.3.4, this function crashes if used with geometries that contain CURVES. This is fixed in 1.3.4+</para></note>
<para>&curve_support;</para>
<para>&P_support;</para>
<para>&T_support;</para>
<para>&Z_support;</para>
</refsection>
<refsection>
<title>Standard Examples</title>
<programlisting>SELECT sometable.field1, sometable.field1,
(ST_Dump(sometable.geom)).geom AS geom
FROM sometable;
-- Break a compound curve into its constituent linestrings and circularstrings
SELECT ST_AsEWKT(a.geom), ST_HasArc(a.geom)
FROM ( SELECT (ST_Dump(p_geom)).geom AS geom
FROM (SELECT ST_GeomFromEWKT('COMPOUNDCURVE(CIRCULARSTRING(0 0, 1 1, 1 0),(1 0, 0 1))') AS p_geom) AS b
) AS a;
st_asewkt | st_hasarc
-----------------------------+----------
CIRCULARSTRING(0 0,1 1,1 0) | t
LINESTRING(1 0,0 1) | f
(2 rows)</programlisting>
</refsection>
<refsection><title>Polyhedral Surfaces, TIN and Triangle Examples</title>
<programlisting>-- Polyhedral surface example
-- Break a Polyhedral surface into its faces
SELECT (a.p_geom).path[1] As path, ST_AsEWKT((a.p_geom).geom) As geom_ewkt
FROM (SELECT ST_Dump(ST_GeomFromEWKT('POLYHEDRALSURFACE(
((0 0 0, 0 0 1, 0 1 1, 0 1 0, 0 0 0)),
((0 0 0, 0 1 0, 1 1 0, 1 0 0, 0 0 0)), ((0 0 0, 1 0 0, 1 0 1, 0 0 1, 0 0 0)), ((1 1 0, 1 1 1, 1 0 1, 1 0 0, 1 1 0)),
((0 1 0, 0 1 1, 1 1 1, 1 1 0, 0 1 0)), ((0 0 1, 1 0 1, 1 1 1, 0 1 1, 0 0 1))
)') ) AS p_geom ) AS a;
path | geom_ewkt
------+------------------------------------------
1 | POLYGON((0 0 0,0 0 1,0 1 1,0 1 0,0 0 0))
2 | POLYGON((0 0 0,0 1 0,1 1 0,1 0 0,0 0 0))
3 | POLYGON((0 0 0,1 0 0,1 0 1,0 0 1,0 0 0))
4 | POLYGON((1 1 0,1 1 1,1 0 1,1 0 0,1 1 0))
5 | POLYGON((0 1 0,0 1 1,1 1 1,1 1 0,0 1 0))
6 | POLYGON((0 0 1,1 0 1,1 1 1,0 1 1,0 0 1))</programlisting>
<programlisting>-- TIN --
SELECT (g.gdump).path, ST_AsEWKT((g.gdump).geom) as wkt
FROM
(SELECT
ST_Dump( ST_GeomFromEWKT('TIN (((
0 0 0,
0 0 1,
0 1 0,
0 0 0
)), ((
0 0 0,
0 1 0,
1 1 0,
0 0 0
))
)') ) AS gdump
) AS g;
-- result --
path | wkt
------+-------------------------------------
{1} | TRIANGLE((0 0 0,0 0 1,0 1 0,0 0 0))
{2} | TRIANGLE((0 0 0,0 1 0,1 1 0,0 0 0))
</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="geometry_dump"/>, <xref linkend="PostGIS_Geometry_DumpFunctions"/>, <xref linkend="ST_Collect"/>, <xref linkend="ST_GeometryN"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_DumpPoints">
<refnamediv>
<refname>ST_DumpPoints</refname>
<refpurpose>Returns a set of <varname>geometry_dump</varname> rows for the coordinates in a geometry.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry_dump[] <function>ST_DumpPoints</function></funcdef>
<paramdef><type>geometry </type> <parameter>geom</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>A set-returning function (SRF) that extracts the coordinates (vertices) of a geometry.
It returns a set of
<xref linkend="geometry_dump"/> rows,
each containing a geometry (<parameter>geom</parameter> field)
and an array of integers (<parameter>path</parameter> field).
</para>
<itemizedlist>
<listitem>
<para>the <parameter>geom</parameter> field
<varname>POINT</varname>s represent the coordinates of the supplied geometry.
</para>
</listitem>
<listitem>
<para>the <parameter>path</parameter> field (an <varname>integer[]</varname>)
is an index enumerating the coordinate positions in the elements of the supplied geometry.
The indices are 1-based.
For example, for a <varname>LINESTRING</varname> the paths are <varname>{i}</varname>
where <varname>i</varname> is the <varname>nth</varname>
coordinate in the <varname>LINESTRING</varname>.
For a <varname>POLYGON</varname> the paths are <varname>{i,j}</varname> where
<varname>i</varname> is the ring number (1 is outer; inner rings follow)
and <varname>j</varname> is the coordinate position in the ring.
</para>
</listitem>
</itemizedlist>
<para>
To obtain a single geometry containing the coordinates use <xref linkend="ST_Points"/>.
</para>
<para role="enhanced" conformance="2.1.0">Enhanced: 2.1.0 Faster speed. Reimplemented as native-C.</para>
<para role="enhanced" conformance="2.0.0">Enhanced: 2.0.0 support for Polyhedral surfaces, Triangles and TIN was introduced.</para>
<para role="availability" conformance="1.5.0">Availability: 1.5.0</para>
<para>&curve_support;</para>
<para>&P_support;</para>
<para>&T_support;</para>
<para>&Z_support;</para>
</refsection>
<refsection><title>Classic Explode a Table of LineStrings into nodes</title>
<programlisting>SELECT edge_id, (dp).path[1] As index, ST_AsText((dp).geom) As wktnode
FROM (SELECT 1 As edge_id
, ST_DumpPoints(ST_GeomFromText('LINESTRING(1 2, 3 4, 10 10)')) AS dp
UNION ALL
SELECT 2 As edge_id
, ST_DumpPoints(ST_GeomFromText('LINESTRING(3 5, 5 6, 9 10)')) AS dp
) As foo;
edge_id | index | wktnode
---------+-------+--------------
1 | 1 | POINT(1 2)
1 | 2 | POINT(3 4)
1 | 3 | POINT(10 10)
2 | 1 | POINT(3 5)
2 | 2 | POINT(5 6)
2 | 3 | POINT(9 10)</programlisting>
</refsection>
<refsection>
<title>Standard Geometry Examples</title>
<informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_dumppoints01.png"/>
</imageobject>
</mediaobject>
</informalfigure>
<programlisting>SELECT path, ST_AsText(geom)
FROM (
SELECT (ST_DumpPoints(g.geom)).*
FROM
(SELECT
'GEOMETRYCOLLECTION(
POINT ( 0 1 ),
LINESTRING ( 0 3, 3 4 ),
POLYGON (( 2 0, 2 3, 0 2, 2 0 )),
POLYGON (( 3 0, 3 3, 6 3, 6 0, 3 0 ),
( 5 1, 4 2, 5 2, 5 1 )),
MULTIPOLYGON (
(( 0 5, 0 8, 4 8, 4 5, 0 5 ),
( 1 6, 3 6, 2 7, 1 6 )),
(( 5 4, 5 8, 6 7, 5 4 ))
)
)'::geometry AS geom
) AS g
) j;
path | st_astext
-----------+------------
{1,1} | POINT(0 1)
{2,1} | POINT(0 3)
{2,2} | POINT(3 4)
{3,1,1} | POINT(2 0)
{3,1,2} | POINT(2 3)
{3,1,3} | POINT(0 2)
{3,1,4} | POINT(2 0)
{4,1,1} | POINT(3 0)
{4,1,2} | POINT(3 3)
{4,1,3} | POINT(6 3)
{4,1,4} | POINT(6 0)
{4,1,5} | POINT(3 0)
{4,2,1} | POINT(5 1)
{4,2,2} | POINT(4 2)
{4,2,3} | POINT(5 2)
{4,2,4} | POINT(5 1)
{5,1,1,1} | POINT(0 5)
{5,1,1,2} | POINT(0 8)
{5,1,1,3} | POINT(4 8)
{5,1,1,4} | POINT(4 5)
{5,1,1,5} | POINT(0 5)
{5,1,2,1} | POINT(1 6)
{5,1,2,2} | POINT(3 6)
{5,1,2,3} | POINT(2 7)
{5,1,2,4} | POINT(1 6)
{5,2,1,1} | POINT(5 4)
{5,2,1,2} | POINT(5 8)
{5,2,1,3} | POINT(6 7)
{5,2,1,4} | POINT(5 4)
(29 rows)</programlisting>
</refsection>
<refsection>
<title>Polyhedral Surfaces, TIN and Triangle Examples</title>
<programlisting>-- Polyhedral surface cube --
SELECT (g.gdump).path, ST_AsEWKT((g.gdump).geom) as wkt
FROM
(SELECT
ST_DumpPoints(ST_GeomFromEWKT('POLYHEDRALSURFACE( ((0 0 0, 0 0 1, 0 1 1, 0 1 0, 0 0 0)),
((0 0 0, 0 1 0, 1 1 0, 1 0 0, 0 0 0)), ((0 0 0, 1 0 0, 1 0 1, 0 0 1, 0 0 0)),
((1 1 0, 1 1 1, 1 0 1, 1 0 0, 1 1 0)),
((0 1 0, 0 1 1, 1 1 1, 1 1 0, 0 1 0)), ((0 0 1, 1 0 1, 1 1 1, 0 1 1, 0 0 1)) )') ) AS gdump
) AS g;
-- result --
path | wkt
---------+--------------
{1,1,1} | POINT(0 0 0)
{1,1,2} | POINT(0 0 1)
{1,1,3} | POINT(0 1 1)
{1,1,4} | POINT(0 1 0)
{1,1,5} | POINT(0 0 0)
{2,1,1} | POINT(0 0 0)
{2,1,2} | POINT(0 1 0)
{2,1,3} | POINT(1 1 0)
{2,1,4} | POINT(1 0 0)
{2,1,5} | POINT(0 0 0)
{3,1,1} | POINT(0 0 0)
{3,1,2} | POINT(1 0 0)
{3,1,3} | POINT(1 0 1)
{3,1,4} | POINT(0 0 1)
{3,1,5} | POINT(0 0 0)
{4,1,1} | POINT(1 1 0)
{4,1,2} | POINT(1 1 1)
{4,1,3} | POINT(1 0 1)
{4,1,4} | POINT(1 0 0)
{4,1,5} | POINT(1 1 0)
{5,1,1} | POINT(0 1 0)
{5,1,2} | POINT(0 1 1)
{5,1,3} | POINT(1 1 1)
{5,1,4} | POINT(1 1 0)
{5,1,5} | POINT(0 1 0)
{6,1,1} | POINT(0 0 1)
{6,1,2} | POINT(1 0 1)
{6,1,3} | POINT(1 1 1)
{6,1,4} | POINT(0 1 1)
{6,1,5} | POINT(0 0 1)
(30 rows)</programlisting>
<programlisting>-- Triangle --
SELECT (g.gdump).path, ST_AsText((g.gdump).geom) as wkt
FROM
(SELECT
ST_DumpPoints( ST_GeomFromEWKT('TRIANGLE ((
0 0,
0 9,
9 0,
0 0
))') ) AS gdump
) AS g;
-- result --
path | wkt
------+------------
{1} | POINT(0 0)
{2} | POINT(0 9)
{3} | POINT(9 0)
{4} | POINT(0 0)
</programlisting>
<programlisting>-- TIN --
SELECT (g.gdump).path, ST_AsEWKT((g.gdump).geom) as wkt
FROM
(SELECT
ST_DumpPoints( ST_GeomFromEWKT('TIN (((
0 0 0,
0 0 1,
0 1 0,
0 0 0
)), ((
0 0 0,
0 1 0,
1 1 0,
0 0 0
))
)') ) AS gdump
) AS g;
-- result --
path | wkt
---------+--------------
{1,1,1} | POINT(0 0 0)
{1,1,2} | POINT(0 0 1)
{1,1,3} | POINT(0 1 0)
{1,1,4} | POINT(0 0 0)
{2,1,1} | POINT(0 0 0)
{2,1,2} | POINT(0 1 0)
{2,1,3} | POINT(1 1 0)
{2,1,4} | POINT(0 0 0)
(8 rows)
</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="geometry_dump"/>, <xref linkend="PostGIS_Geometry_DumpFunctions"/>,
<xref linkend="ST_Dump"/>, <xref linkend="ST_DumpRings"/>, <xref linkend="ST_Points"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_DumpSegments">
<refnamediv>
<refname>ST_DumpSegments</refname>
<refpurpose>Returns a set of <varname>geometry_dump</varname> rows for the segments in a geometry.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry_dump[] <function>ST_DumpSegments</function></funcdef>
<paramdef><type>geometry </type> <parameter>geom</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>A set-returning function (SRF) that extracts the segments of a geometry.
It returns a set of
<xref linkend="geometry_dump"/> rows,
each containing a geometry (<parameter>geom</parameter> field)
and an array of integers (<parameter>path</parameter> field).
</para>
<itemizedlist>
<listitem>
<para>the <parameter>geom</parameter> field
<varname>LINESTRING</varname>s represent the linear segments of the supplied geometry, while the <varname>CIRCULARSTRING</varname>s represent the arc segments.
</para>
</listitem>
<listitem>
<para>the <parameter>path</parameter> field (an <varname>integer[]</varname>)
is an index enumerating the segment start point positions in the elements of the supplied geometry.
The indices are 1-based.
For example, for a <varname>LINESTRING</varname> the paths are <varname>{i}</varname>
where <varname>i</varname> is the <varname>nth</varname>
segment start point in the <varname>LINESTRING</varname>.
For a <varname>POLYGON</varname> the paths are <varname>{i,j}</varname> where
<varname>i</varname> is the ring number (1 is outer; inner rings follow)
and <varname>j</varname> is the segment start point position in the ring.
</para>
</listitem>
</itemizedlist>
<para role="availability" conformance="3.2.0">Availability: 3.2.0</para>
<para>&T_support;</para>
<para>&Z_support;</para>
</refsection>
<refsection>
<title>Standard Geometry Examples</title>
<programlisting>SELECT path, ST_AsText(geom)
FROM (
SELECT (ST_DumpSegments(g.geom)).*
FROM (SELECT 'GEOMETRYCOLLECTION(
LINESTRING(1 1, 3 3, 4 4),
POLYGON((5 5, 6 6, 7 7, 5 5))
)'::geometry AS geom
) AS g
) j;
path │ st_astext
---------------------------------
{1,1} │ LINESTRING(1 1,3 3)
{1,2} │ LINESTRING(3 3,4 4)
{2,1,1} │ LINESTRING(5 5,6 6)
{2,1,2} │ LINESTRING(6 6,7 7)
{2,1,3} │ LINESTRING(7 7,5 5)
(5 rows)</programlisting>
</refsection>
<refsection>
<title>TIN and Triangle Examples</title>
<programlisting>-- Triangle --
SELECT path, ST_AsText(geom)
FROM (
SELECT (ST_DumpSegments(g.geom)).*
FROM (SELECT 'TRIANGLE((
0 0,
0 9,
9 0,
0 0
))'::geometry AS geom
) AS g
) j;
path │ st_astext
---------------------------------
{1,1} │ LINESTRING(0 0,0 9)
{1,2} │ LINESTRING(0 9,9 0)
{1,3} │ LINESTRING(9 0,0 0)
(3 rows)
</programlisting>
<programlisting>-- TIN --
SELECT path, ST_AsEWKT(geom)
FROM (
SELECT (ST_DumpSegments(g.geom)).*
FROM (SELECT 'TIN(((
0 0 0,
0 0 1,
0 1 0,
0 0 0
)), ((
0 0 0,
0 1 0,
1 1 0,
0 0 0
))
)'::geometry AS geom
) AS g
) j;
path │ st_asewkt
---------------------------------
{1,1,1} │ LINESTRING(0 0 0,0 0 1)
{1,1,2} │ LINESTRING(0 0 1,0 1 0)
{1,1,3} │ LINESTRING(0 1 0,0 0 0)
{2,1,1} │ LINESTRING(0 0 0,0 1 0)
{2,1,2} │ LINESTRING(0 1 0,1 1 0)
{2,1,3} │ LINESTRING(1 1 0,0 0 0)
(6 rows)
</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="geometry_dump"/>, <xref linkend="PostGIS_Geometry_DumpFunctions"/>,
<xref linkend="ST_Dump"/>, <xref linkend="ST_DumpRings"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_DumpRings">
<refnamediv>
<refname>ST_DumpRings</refname>
<refpurpose>Returns a set of <varname>geometry_dump</varname> rows for
the exterior and interior rings of a Polygon.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry_dump[] <function>ST_DumpRings</function></funcdef>
<paramdef><type>geometry </type> <parameter>a_polygon</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>A set-returning function (SRF) that extracts the rings of a polygon.
It returns a set of <xref linkend="geometry_dump"/> rows,
each containing a geometry (<parameter>geom</parameter> field)
and an array of integers (<parameter>path</parameter> field).
</para>
<para>
The <parameter>geom</parameter> field contains each ring as a POLYGON.
The <parameter>path</parameter> field is an integer array of length 1 containing the polygon ring index.
The exterior ring (shell) has index 0. The interior rings (holes) have indices of 1 and higher.
</para>
<note><para>This only works for POLYGON geometries. It does not work for MULTIPOLYGONS</para></note>
<para role="availability" conformance="1.1.3.">Availability: PostGIS 1.1.3. Requires PostgreSQL 7.3 or higher.</para>
<para>&Z_support;</para>
</refsection>
<refsection>
<title>Examples</title>
<para>General form of query.</para>
<programlisting>SELECT polyTable.field1, polyTable.field1,
(ST_DumpRings(polyTable.geom)).geom As geom
FROM polyTable;
</programlisting>
<para>A polygon with a single hole.</para>
<programlisting>SELECT path, ST_AsEWKT(geom) As geom
FROM ST_DumpRings(
ST_GeomFromEWKT('POLYGON((-8149064 5133092 1,-8149064 5132986 1,-8148996 5132839 1,-8148972 5132767 1,-8148958 5132508 1,-8148941 5132466 1,-8148924 5132394 1,
-8148903 5132210 1,-8148930 5131967 1,-8148992 5131978 1,-8149237 5132093 1,-8149404 5132211 1,-8149647 5132310 1,-8149757 5132394 1,
-8150305 5132788 1,-8149064 5133092 1),
(-8149362 5132394 1,-8149446 5132501 1,-8149548 5132597 1,-8149695 5132675 1,-8149362 5132394 1))')
) as foo;
path | geom
----------------------------------------------------------------------------------------------------------------
{0} | POLYGON((-8149064 5133092 1,-8149064 5132986 1,-8148996 5132839 1,-8148972 5132767 1,-8148958 5132508 1,
| -8148941 5132466 1,-8148924 5132394 1,
| -8148903 5132210 1,-8148930 5131967 1,
| -8148992 5131978 1,-8149237 5132093 1,
| -8149404 5132211 1,-8149647 5132310 1,-8149757 5132394 1,-8150305 5132788 1,-8149064 5133092 1))
{1} | POLYGON((-8149362 5132394 1,-8149446 5132501 1,
| -8149548 5132597 1,-8149695 5132675 1,-8149362 5132394 1))</programlisting>
</refsection>
<!-- Optionally add a "See Also" section -->
<refsection>
<title>See Also</title>
<para><xref linkend="geometry_dump"/>, <xref linkend="PostGIS_Geometry_DumpFunctions"/>, <xref linkend="ST_Dump"/>, <xref linkend="ST_ExteriorRing"/>, <xref linkend="ST_InteriorRingN"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_EndPoint">
<refnamediv>
<refname>ST_EndPoint</refname>
<refpurpose>Returns the last point of a LineString or CircularLineString.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_EndPoint</function></funcdef>
<paramdef><type>geometry </type> <parameter>g</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Returns the last point of a <varname>LINESTRING</varname>
or <varname>CIRCULARLINESTRING</varname> geometry
as a <varname>POINT</varname>.
Returns <varname>NULL</varname> if the input
is not a <varname>LINESTRING</varname> or <varname>CIRCULARLINESTRING</varname>.</para>
<para>&sqlmm_compliant; SQL-MM 3: 7.1.4</para>
<para>&Z_support;</para>
<para>&curve_support;</para>
<note><para role="changed" conformance="2.0.0">Changed: 2.0.0 no longer works with single geometry MultiLineStrings. In older
versions of PostGIS a single-line MultiLineString would work with this
function and return the end point. In 2.0.0 it returns NULL like any other MultiLineString.
The old behavior was an undocumented feature, but people who assumed they had their data stored as LINESTRING
may experience these returning NULL in 2.0.0.</para></note>
</refsection>
<refsection>
<title>Examples</title>
<para>End point of a LineString</para>
<programlisting>postgis=# SELECT ST_AsText(ST_EndPoint('LINESTRING(1 1, 2 2, 3 3)'::geometry));
st_astext
------------
POINT(3 3)
</programlisting>
<para>End point of a non-LineString is NULL</para>
<programlisting>
SELECT ST_EndPoint('POINT(1 1)'::geometry) IS NULL AS is_null;
is_null
----------
t
</programlisting>
<para>End point of a 3D LineString</para>
<programlisting>
--3d endpoint
SELECT ST_AsEWKT(ST_EndPoint('LINESTRING(1 1 2, 1 2 3, 0 0 5)'));
st_asewkt
--------------
POINT(0 0 5)
</programlisting>
<para>End point of a CircularString</para>
<programlisting>
SELECT ST_AsText(ST_EndPoint('CIRCULARSTRING(5 2,-3 1.999999, -2 1, -4 2, 6 3)'::geometry));
st_astext
------------
POINT(6 3)
</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_PointN"/>, <xref linkend="ST_StartPoint"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_Envelope">
<refnamediv>
<refname>ST_Envelope</refname>
<refpurpose>Returns a geometry representing the bounding box of a geometry.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_Envelope</function></funcdef>
<paramdef><type>geometry </type> <parameter>g1</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Returns the double-precision (float8) minimum bounding box for the supplied geometry, as a geometry.
The polygon is defined by the corner points of the bounding box
((<varname>MINX</varname>, <varname>MINY</varname>),
(<varname>MINX</varname>, <varname>MAXY</varname>),
(<varname>MAXX</varname>, <varname>MAXY</varname>),
(<varname>MAXX</varname>, <varname>MINY</varname>),
(<varname>MINX</varname>, <varname>MINY</varname>)). (PostGIS will add a
<varname>ZMIN</varname>/<varname>ZMAX</varname> coordinate as
well).</para>
<para>Degenerate cases (vertical lines, points) will return a geometry of
lower dimension than <varname>POLYGON</varname>, ie.
<varname>POINT</varname> or <varname>LINESTRING</varname>.</para>
<para role="availability" conformance="1.5.0">Availability: 1.5.0 behavior changed to output double precision instead of float4</para>
<para>&sfs_compliant; s2.1.1.1</para>
<para>&sqlmm_compliant; SQL-MM 3: 5.1.19</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>
SELECT ST_AsText(ST_Envelope('POINT(1 3)'::geometry));
st_astext
------------
POINT(1 3)
(1 row)
SELECT ST_AsText(ST_Envelope('LINESTRING(0 0, 1 3)'::geometry));
st_astext
--------------------------------
POLYGON((0 0,0 3,1 3,1 0,0 0))
(1 row)
SELECT ST_AsText(ST_Envelope('POLYGON((0 0, 0 1, 1.0000001 1, 1.0000001 0, 0 0))'::geometry));
st_astext
--------------------------------------------------------------
POLYGON((0 0,0 1,1.00000011920929 1,1.00000011920929 0,0 0))
(1 row)
SELECT ST_AsText(ST_Envelope('POLYGON((0 0, 0 1, 1.0000000001 1, 1.0000000001 0, 0 0))'::geometry));
st_astext
--------------------------------------------------------------
POLYGON((0 0,0 1,1.00000011920929 1,1.00000011920929 0,0 0))
(1 row)
SELECT Box3D(geom), Box2D(geom), ST_AsText(ST_Envelope(geom)) As envelopewkt
FROM (SELECT 'POLYGON((0 0, 0 1000012333334.34545678, 1.0000001 1, 1.0000001 0, 0 0))'::geometry As geom) As foo;
<!-- TODO: Fix examples to reflect new behavior -->
</programlisting>
<informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_envelope01.png"/>
</imageobject>
<caption><para>Envelope of a point and linestring.</para></caption>
</mediaobject>
</informalfigure>
<programlisting>
SELECT ST_AsText(ST_Envelope(
ST_Collect(
ST_GeomFromText('LINESTRING(55 75,125 150)'),
ST_Point(20, 80))
)) As wktenv;
wktenv
-----------
POLYGON((20 75,20 150,125 150,125 75,20 75))</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="Box2D"/>, <xref linkend="Box3D"/>, <xref linkend="ST_OrientedEnvelope"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_ExteriorRing">
<refnamediv>
<refname>ST_ExteriorRing</refname>
<refpurpose>Returns a LineString representing the exterior ring of a Polygon. </refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_ExteriorRing</function></funcdef>
<paramdef><type>geometry </type> <parameter>a_polygon</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Returns a LINESTRING representing the exterior ring (shell) of a POLYGON.
Returns NULL if the geometry is not a polygon.</para>
<note>
<para>This function does not support MULTIPOLYGONs.
For MULTIPOLYGONs use in conjunction with <xref linkend="ST_GeometryN"/> or <xref linkend="ST_Dump"/> </para>
</note>
<para>&sfs_compliant; 2.1.5.1</para>
<para>&sqlmm_compliant; SQL-MM 3: 8.2.3, 8.3.3</para>
<para>&Z_support;</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>
--If you have a table of polygons
SELECT gid, ST_ExteriorRing(geom) AS ering
FROM sometable;
--If you have a table of MULTIPOLYGONs
--and want to return a MULTILINESTRING composed of the exterior rings of each polygon
SELECT gid, ST_Collect(ST_ExteriorRing(geom)) AS erings
FROM (SELECT gid, (ST_Dump(geom)).geom As geom
FROM sometable) As foo
GROUP BY gid;
--3d Example
SELECT ST_AsEWKT(
ST_ExteriorRing(
ST_GeomFromEWKT('POLYGON((0 0 1, 1 1 1, 1 2 1, 1 1 1, 0 0 1))')
)
);
st_asewkt
---------
LINESTRING(0 0 1,1 1 1,1 2 1,1 1 1,0 0 1)
</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para>
<xref linkend="ST_InteriorRingN"/>,
<xref linkend="ST_Boundary"/>,
<xref linkend="ST_NumInteriorRings"/>
</para>
</refsection>
</refentry>
<refentry xml:id="ST_GeometryN">
<refnamediv>
<refname>ST_GeometryN</refname>
<refpurpose>Return an element of a geometry collection.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_GeometryN</function></funcdef>
<paramdef><type>geometry </type> <parameter>geomA</parameter></paramdef>
<paramdef><type>integer </type> <parameter>n</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Return the 1-based Nth element geometry of an input geometry which is a
GEOMETRYCOLLECTION, MULTIPOINT, MULTILINESTRING, MULTICURVE, MULTI)POLYGON, or POLYHEDRALSURFACE.
Otherwise, returns NULL.</para>
<note>
<para>Index is 1-based as for OGC specs since version 0.8.0.
Previous versions implemented this as 0-based instead.</para>
</note>
<note>
<para>To extract all elements of a geometry, <xref linkend="ST_Dump"/> is more efficient and works for atomic geometries.</para>
</note>
<para role="enhanced" conformance="2.0.0">Enhanced: 2.0.0 support for Polyhedral surfaces, Triangles and TIN was introduced.</para>
<para role="changed" conformance="2.0.0">Changed: 2.0.0 Prior versions would return NULL for singular geometries. This was changed to return the geometry for ST_GeometryN(..,1) case.</para>
<para>&sfs_compliant;</para>
<para>&sqlmm_compliant; SQL-MM 3: 9.1.5</para>
<para>&Z_support;</para>
<para>&curve_support;</para>
<para>&P_support;</para>
<para>&T_support;</para>
</refsection>
<refsection>
<title>Standard Examples</title>
<programlisting><![CDATA[
--Extracting a subset of points from a 3d multipoint
SELECT n, ST_AsEWKT(ST_GeometryN(geom, n)) As geomewkt
FROM (
VALUES (ST_GeomFromEWKT('MULTIPOINT((1 2 7), (3 4 7), (5 6 7), (8 9 10))') ),
( ST_GeomFromEWKT('MULTICURVE(CIRCULARSTRING(2.5 2.5,4.5 2.5, 3.5 3.5), (10 11, 12 11))') )
)As foo(geom)
CROSS JOIN generate_series(1,100) n
WHERE n <= ST_NumGeometries(geom);
n | geomewkt
---+-----------------------------------------
1 | POINT(1 2 7)
2 | POINT(3 4 7)
3 | POINT(5 6 7)
4 | POINT(8 9 10)
1 | CIRCULARSTRING(2.5 2.5,4.5 2.5,3.5 3.5)
2 | LINESTRING(10 11,12 11)
--Extracting all geometries (useful when you want to assign an id)
SELECT gid, n, ST_GeometryN(geom, n)
FROM sometable CROSS JOIN generate_series(1,100) n
WHERE n <= ST_NumGeometries(geom);
]]></programlisting>
</refsection>
<refsection><title>Polyhedral Surfaces, TIN and Triangle Examples</title>
<programlisting>-- Polyhedral surface example
-- Break a Polyhedral surface into its faces
SELECT ST_AsEWKT(ST_GeometryN(p_geom,3)) As geom_ewkt
FROM (SELECT ST_GeomFromEWKT('POLYHEDRALSURFACE(
((0 0 0, 0 0 1, 0 1 1, 0 1 0, 0 0 0)),
((0 0 0, 0 1 0, 1 1 0, 1 0 0, 0 0 0)),
((0 0 0, 1 0 0, 1 0 1, 0 0 1, 0 0 0)),
((1 1 0, 1 1 1, 1 0 1, 1 0 0, 1 1 0)),
((0 1 0, 0 1 1, 1 1 1, 1 1 0, 0 1 0)),
((0 0 1, 1 0 1, 1 1 1, 0 1 1, 0 0 1))
)') AS p_geom ) AS a;
geom_ewkt
------------------------------------------
POLYGON((0 0 0,1 0 0,1 0 1,0 0 1,0 0 0))</programlisting>
<programlisting>-- TIN --
SELECT ST_AsEWKT(ST_GeometryN(geom,2)) as wkt
FROM
(SELECT
ST_GeomFromEWKT('TIN (((
0 0 0,
0 0 1,
0 1 0,
0 0 0
)), ((
0 0 0,
0 1 0,
1 1 0,
0 0 0
))
)') AS geom
) AS g;
-- result --
wkt
-------------------------------------
TRIANGLE((0 0 0,0 1 0,1 1 0,0 0 0))</programlisting>
</refsection>
<!-- Optionally add a "See Also" section -->
<refsection>
<title>See Also</title>
<para><xref linkend="ST_Dump"/>, <xref linkend="ST_NumGeometries"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_GeometryType">
<refnamediv>
<refname>ST_GeometryType</refname>
<refpurpose>Returns the SQL-MM type of a geometry as text.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>text <function>ST_GeometryType</function></funcdef>
<paramdef><type>geometry </type> <parameter>g1</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Returns the type of the geometry as a string. EG: 'ST_LineString', 'ST_Polygon','ST_MultiPolygon' etc. This function differs from GeometryType(geometry) in the case of the string and ST in front that is returned, as well as the fact that it will not indicate whether the geometry is measured.</para>
<para role="enhanced" conformance="2.0.0">Enhanced: 2.0.0 support for Polyhedral surfaces was introduced.</para>
<para>&sqlmm_compliant; SQL-MM 3: 5.1.4</para>
<para>&Z_support;</para>
<para>&P_support;</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>SELECT ST_GeometryType(ST_GeomFromText('LINESTRING(77.29 29.07,77.42 29.26,77.27 29.31,77.29 29.07)'));
--result
ST_LineString</programlisting>
<programlisting>SELECT ST_GeometryType(ST_GeomFromEWKT('POLYHEDRALSURFACE( ((0 0 0, 0 0 1, 0 1 1, 0 1 0, 0 0 0)),
((0 0 0, 0 1 0, 1 1 0, 1 0 0, 0 0 0)), ((0 0 0, 1 0 0, 1 0 1, 0 0 1, 0 0 0)),
((1 1 0, 1 1 1, 1 0 1, 1 0 0, 1 1 0)),
((0 1 0, 0 1 1, 1 1 1, 1 1 0, 0 1 0)), ((0 0 1, 1 0 1, 1 1 1, 0 1 1, 0 0 1)) )'));
--result
ST_PolyhedralSurface</programlisting>
<programlisting>SELECT ST_GeometryType(ST_GeomFromEWKT('POLYHEDRALSURFACE( ((0 0 0, 0 0 1, 0 1 1, 0 1 0, 0 0 0)),
((0 0 0, 0 1 0, 1 1 0, 1 0 0, 0 0 0)), ((0 0 0, 1 0 0, 1 0 1, 0 0 1, 0 0 0)),
((1 1 0, 1 1 1, 1 0 1, 1 0 0, 1 1 0)),
((0 1 0, 0 1 1, 1 1 1, 1 1 0, 0 1 0)), ((0 0 1, 1 0 1, 1 1 1, 0 1 1, 0 0 1)) )'));
--result
ST_PolyhedralSurface</programlisting>
<programlisting>SELECT ST_GeometryType(geom) as result
FROM
(SELECT
ST_GeomFromEWKT('TIN (((
0 0 0,
0 0 1,
0 1 0,
0 0 0
)), ((
0 0 0,
0 1 0,
1 1 0,
0 0 0
))
)') AS geom
) AS g;
result
--------
ST_Tin </programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="GeometryType"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_HasArc">
<refnamediv>
<refname>ST_HasArc</refname>
<refpurpose>Tests if a geometry contains a circular arc</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>boolean <function>ST_HasArc</function></funcdef>
<paramdef><type>geometry </type> <parameter>geomA</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Returns true if a geometry or geometry collection contains a circular string</para>
<para role="availability" conformance="1.2.3">Availability: 1.2.3?</para>
<para>&Z_support;</para>
<para>&curve_support;</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>SELECT ST_HasArc(ST_Collect('LINESTRING(1 2, 3 4, 5 6)', 'CIRCULARSTRING(1 1, 2 3, 4 5, 6 7, 5 6)'));
st_hasarc
--------
t
</programlisting>
</refsection>
<!-- Optionally add a "See Also" section -->
<refsection>
<title>See Also</title>
<para><xref linkend="ST_CurveToLine"/>, <xref linkend="ST_LineToCurve"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_InteriorRingN">
<refnamediv>
<refname>ST_InteriorRingN</refname>
<refpurpose>Returns the Nth interior ring (hole) of a Polygon.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_InteriorRingN</function></funcdef>
<paramdef><type>geometry </type> <parameter>a_polygon</parameter></paramdef>
<paramdef><type>integer </type> <parameter>n</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Returns the Nth interior ring (hole) of a POLYGON geometry as a LINESTRING. The index starts at 1. Returns NULL if the geometry is not a polygon or the index is out of range.</para>
<!-- optionally mention that this function uses indexes if appropriate -->
<note>
<para>This function does not support MULTIPOLYGONs.
For MULTIPOLYGONs use in conjunction with <xref linkend="ST_GeometryN"/> or <xref linkend="ST_Dump"/> </para>
</note>
<para>&sfs_compliant;</para>
<para>&sqlmm_compliant; SQL-MM 3: 8.2.6, 8.3.5</para>
<para>&Z_support;</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>
SELECT ST_AsText(ST_InteriorRingN(geom, 1)) As geom
FROM (SELECT ST_BuildArea(
ST_Collect(ST_Buffer(ST_Point(1,2), 20,3),
ST_Buffer(ST_Point(1, 2), 10,3))) As geom
) as foo;
</programlisting>
</refsection>
<!-- Optionally add a "See Also" section -->
<refsection>
<title>See Also</title>
<para>
<xref linkend="ST_ExteriorRing"/>,
<xref linkend="ST_BuildArea"/>,
<xref linkend="ST_Collect"/>,
<xref linkend="ST_Dump"/>,
<xref linkend="ST_NumInteriorRing"/>,
<xref linkend="ST_NumInteriorRings"/>
</para>
</refsection>
</refentry>
<refentry xml:id="ST_NumCurves">
<refnamediv>
<refname>ST_NumCurves</refname>
<refpurpose>Return the number of component curves in a CompoundCurve.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>integer <function>ST_NumCurves</function></funcdef>
<paramdef><type>geometry </type> <parameter>a_compoundcurve</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Return the number of component curves in a CompoundCurve, zero for an empty CompoundCurve, or NULL for a non-CompoundCurve input. </para>
<para>&sqlmm_compliant; SQL-MM 3: 8.2.6, 8.3.5</para>
<para>&Z_support;</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>
-- Returns 3
SELECT ST_NumCurves('COMPOUNDCURVE(
(2 2, 2.5 2.5),
CIRCULARSTRING(2.5 2.5, 4.5 2.5, 3.5 3.5),
(3.5 3.5, 2.5 4.5, 3 5, 2 2)
)');
-- Returns 0
SELECT ST_NumCurves('COMPOUNDCURVE EMPTY');
</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para>
<xref linkend="ST_CurveN"/>,
<xref linkend="ST_Dump"/>,
<xref linkend="ST_ExteriorRing"/>,
<xref linkend="ST_NumInteriorRings"/>,
<xref linkend="ST_NumGeometries"/>
</para>
</refsection>
</refentry>
<refentry xml:id="ST_CurveN">
<refnamediv>
<refname>ST_CurveN</refname>
<refpurpose>Returns the Nth component curve geometry of a CompoundCurve.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_CurveN</function></funcdef>
<paramdef><type>geometry </type> <parameter>a_compoundcurve</parameter></paramdef>
<paramdef><type>integer </type> <parameter>index</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Returns the Nth component curve geometry of a CompoundCurve. The index starts at 1. Returns NULL if the geometry is not a CompoundCurve or the index is out of range.</para>
<para>&sqlmm_compliant; SQL-MM 3: 8.2.6, 8.3.5</para>
<para>&Z_support;</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>
SELECT ST_AsText(ST_CurveN('COMPOUNDCURVE(
(2 2, 2.5 2.5),
CIRCULARSTRING(2.5 2.5, 4.5 2.5, 3.5 3.5),
(3.5 3.5, 2.5 4.5, 3 5, 2 2)
)', 1));
</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para>
<xref linkend="ST_NumCurves"/>,
<xref linkend="ST_Dump"/>,
<xref linkend="ST_ExteriorRing"/>,
<xref linkend="ST_NumInteriorRings"/>,
<xref linkend="ST_NumGeometries"/>
</para>
</refsection>
</refentry>
<refentry xml:id="ST_IsClosed">
<refnamediv>
<refname>ST_IsClosed</refname>
<refpurpose>Tests if a LineStrings's start and end points are coincident. For a PolyhedralSurface tests if it is closed (volumetric).
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>boolean <function>ST_IsClosed</function></funcdef>
<paramdef><type>geometry </type> <parameter>g</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Returns <varname>TRUE</varname> if the <varname>LINESTRING</varname>'s
start and end points are coincident.
For Polyhedral Surfaces, reports if the surface is areal (open) or volumetric (closed).</para>
<para>&sfs_compliant;</para>
<para>&sqlmm_compliant; SQL-MM 3: 7.1.5, 9.3.3</para>
<note>
<para>SQL-MM defines the result of
<code>ST_IsClosed(NULL)</code> to be 0, while
PostGIS returns <varname>NULL</varname>.</para>
</note>
<para>&Z_support;</para>
<para>&curve_support;</para>
<para role="enhanced" conformance="2.0.0">Enhanced: 2.0.0 support for Polyhedral surfaces was introduced.</para>
<para>&P_support;</para>
</refsection>
<refsection>
<title>Line String and Point Examples</title>
<programlisting>postgis=# SELECT ST_IsClosed('LINESTRING(0 0, 1 1)'::geometry);
st_isclosed
-------------
f
(1 row)
postgis=# SELECT ST_IsClosed('LINESTRING(0 0, 0 1, 1 1, 0 0)'::geometry);
st_isclosed
-------------
t
(1 row)
postgis=# SELECT ST_IsClosed('MULTILINESTRING((0 0, 0 1, 1 1, 0 0),(0 0, 1 1))'::geometry);
st_isclosed
-------------
f
(1 row)
postgis=# SELECT ST_IsClosed('POINT(0 0)'::geometry);
st_isclosed
-------------
t
(1 row)
postgis=# SELECT ST_IsClosed('MULTIPOINT((0 0), (1 1))'::geometry);
st_isclosed
-------------
t
(1 row)</programlisting>
</refsection>
<refsection>
<title>Polyhedral Surface Examples</title>
<programlisting>
-- A cube --
SELECT ST_IsClosed(ST_GeomFromEWKT('POLYHEDRALSURFACE( ((0 0 0, 0 0 1, 0 1 1, 0 1 0, 0 0 0)),
((0 0 0, 0 1 0, 1 1 0, 1 0 0, 0 0 0)), ((0 0 0, 1 0 0, 1 0 1, 0 0 1, 0 0 0)),
((1 1 0, 1 1 1, 1 0 1, 1 0 0, 1 1 0)),
((0 1 0, 0 1 1, 1 1 1, 1 1 0, 0 1 0)), ((0 0 1, 1 0 1, 1 1 1, 0 1 1, 0 0 1)) )'));
st_isclosed
-------------
t
-- Same as cube but missing a side --
SELECT ST_IsClosed(ST_GeomFromEWKT('POLYHEDRALSURFACE( ((0 0 0, 0 0 1, 0 1 1, 0 1 0, 0 0 0)),
((0 0 0, 0 1 0, 1 1 0, 1 0 0, 0 0 0)), ((0 0 0, 1 0 0, 1 0 1, 0 0 1, 0 0 0)),
((1 1 0, 1 1 1, 1 0 1, 1 0 0, 1 1 0)),
((0 1 0, 0 1 1, 1 1 1, 1 1 0, 0 1 0)) )'));
st_isclosed
-------------
f
</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_IsRing"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_IsCollection">
<refnamediv>
<refname>ST_IsCollection</refname>
<refpurpose>Tests if a geometry is a geometry collection type.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>boolean <function>ST_IsCollection</function></funcdef>
<paramdef><type>geometry </type> <parameter>g</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Returns <varname>TRUE</varname> if the geometry type of
the argument a geometry collection type. Collection types are the following:
<itemizedlist>
<listitem><para>GEOMETRYCOLLECTION</para></listitem>
<listitem><para>MULTI{POINT,POLYGON,LINESTRING,CURVE,SURFACE}</para></listitem>
<listitem><para>COMPOUNDCURVE</para></listitem>
</itemizedlist>
</para>
<note>
<para>
This function analyzes the type of the geometry. This means
that it will return <varname>TRUE</varname> on collections
that are empty or that contain a single element.
</para>
</note>
<para>&Z_support;</para>
<para>&curve_support;</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>postgis=# SELECT ST_IsCollection('LINESTRING(0 0, 1 1)'::geometry);
st_iscollection
-------------
f
(1 row)
postgis=# SELECT ST_IsCollection('MULTIPOINT EMPTY'::geometry);
st_iscollection
-------------
t
(1 row)
postgis=# SELECT ST_IsCollection('MULTIPOINT((0 0))'::geometry);
st_iscollection
-------------
t
(1 row)
postgis=# SELECT ST_IsCollection('MULTIPOINT((0 0), (42 42))'::geometry);
st_iscollection
-------------
t
(1 row)
postgis=# SELECT ST_IsCollection('GEOMETRYCOLLECTION(POINT(0 0))'::geometry);
st_iscollection
-------------
t
(1 row)</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_NumGeometries"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_IsEmpty">
<refnamediv>
<refname>ST_IsEmpty</refname>
<refpurpose>Tests if a geometry is empty.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>boolean <function>ST_IsEmpty</function></funcdef>
<paramdef><type>geometry </type> <parameter>geomA</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Returns true if this Geometry is an empty geometry. If
true, then this Geometry represents an empty geometry collection, polygon, point etc.</para>
<note>
<para>SQL-MM defines the result of ST_IsEmpty(NULL) to be 0, while
PostGIS returns NULL.</para>
</note>
<para>&sfs_compliant; s2.1.1.1</para>
<para>&sqlmm_compliant; SQL-MM 3: 5.1.7</para>
<para>&curve_support;</para>
<warning><para role="changed" conformance="2.0.0">Changed: 2.0.0 In prior versions of PostGIS ST_GeomFromText('GEOMETRYCOLLECTION(EMPTY)') was allowed. This is now illegal in PostGIS 2.0.0 to better conform with SQL/MM standards</para></warning>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>
SELECT ST_IsEmpty(ST_GeomFromText('GEOMETRYCOLLECTION EMPTY'));
st_isempty
------------
t
(1 row)
SELECT ST_IsEmpty(ST_GeomFromText('POLYGON EMPTY'));
st_isempty
------------
t
(1 row)
SELECT ST_IsEmpty(ST_GeomFromText('POLYGON((1 2, 3 4, 5 6, 1 2))'));
st_isempty
------------
f
(1 row)
SELECT ST_IsEmpty(ST_GeomFromText('POLYGON((1 2, 3 4, 5 6, 1 2))')) = false;
?column?
----------
t
(1 row)
SELECT ST_IsEmpty(ST_GeomFromText('CIRCULARSTRING EMPTY'));
st_isempty
------------
t
(1 row)
</programlisting>
</refsection>
</refentry>
<refentry xml:id="ST_IsPolygonCCW">
<refnamediv>
<refname>
ST_IsPolygonCCW
</refname>
<refpurpose>Tests if Polygons have exterior rings oriented counter-clockwise and interior rings oriented clockwise.
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>
boolean
<function>ST_IsPolygonCCW</function>
</funcdef>
<paramdef>
<type>geometry</type>
<parameter>geom</parameter>
</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>
Returns true if all polygonal components of the input geometry use a counter-clockwise
orientation for their exterior ring, and a clockwise direction
for all interior rings.
</para>
<para>
Returns true if the geometry has no polygonal components.
</para>
<note>
<para>
Closed linestrings are not considered polygonal components,
so you would still get a true return by passing
a single closed linestring no matter its orientation.
</para>
</note>
<note>
<para>
If a polygonal geometry does not use reversed orientation
for interior rings (i.e., if one or more interior rings
are oriented in the same direction as an exterior ring)
then both ST_IsPolygonCW and ST_IsPolygonCCW will return false.
</para>
</note>
<para role="availability" conformance="2.4.0">Availability: 2.4.0</para>
<para>&Z_support;</para>
<para>&M_support;</para>
</refsection>
<refsection>
<title>See Also</title>
<para>
<xref linkend="ST_ForcePolygonCW"/>,
<xref linkend="ST_ForcePolygonCCW"/>,
<xref linkend="ST_IsPolygonCW"/>
</para>
</refsection>
</refentry>
<refentry xml:id="ST_IsPolygonCW">
<refnamediv>
<refname>
ST_IsPolygonCW
</refname>
<refpurpose>Tests if Polygons have exterior rings oriented clockwise and interior rings oriented counter-clockwise.
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>
boolean
<function>ST_IsPolygonCW</function>
</funcdef>
<paramdef>
<type>geometry</type>
<parameter>geom</parameter>
</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>
Returns true if all polygonal components of the input geometry use a clockwise
orientation for their exterior ring, and a counter-clockwise direction
for all interior rings.
</para>
<para>
Returns true if the geometry has no polygonal components.
</para>
<note>
<para>
Closed linestrings are not considered polygonal components,
so you would still get a true return by passing
a single closed linestring no matter its orientation.
</para>
</note>
<note>
<para>
If a polygonal geometry does not use reversed orientation
for interior rings (i.e., if one or more interior rings
are oriented in the same direction as an exterior ring)
then both ST_IsPolygonCW and ST_IsPolygonCCW will return false.
</para>
</note>
<para role="availability" conformance="2.4.0">Availability: 2.4.0</para>
<para>&Z_support;</para>
<para>&M_support;</para>
</refsection>
<refsection>
<title>See Also</title>
<para>
<xref linkend="ST_ForcePolygonCW"/>,
<xref linkend="ST_ForcePolygonCCW"/>,
<xref linkend="ST_IsPolygonCW"/>
</para>
</refsection>
</refentry>
<refentry xml:id="ST_IsRing">
<refnamediv>
<refname>ST_IsRing</refname>
<refpurpose>Tests if a LineString is closed and simple.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>boolean <function>ST_IsRing</function></funcdef>
<paramdef><type>geometry </type> <parameter>g</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Returns <varname>TRUE</varname> if this
<varname>LINESTRING</varname> is both <xref linkend="ST_IsClosed" />
(<code>ST_StartPoint(g) ~= ST_Endpoint(g)</code>) and <xref
linkend="ST_IsSimple" /> (does not self intersect).</para>
<para>&sfs_compliant; 2.1.5.1</para>
<para>&sqlmm_compliant; SQL-MM 3: 7.1.6</para>
<note>
<para>SQL-MM defines the result of
<code>ST_IsRing(NULL)</code> to be 0, while
PostGIS returns <varname>NULL</varname>.</para>
</note>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>SELECT ST_IsRing(geom), ST_IsClosed(geom), ST_IsSimple(geom)
FROM (SELECT 'LINESTRING(0 0, 0 1, 1 1, 1 0, 0 0)'::geometry AS geom) AS foo;
st_isring | st_isclosed | st_issimple
-----------+-------------+-------------
t | t | t
(1 row)
SELECT ST_IsRing(geom), ST_IsClosed(geom), ST_IsSimple(geom)
FROM (SELECT 'LINESTRING(0 0, 0 1, 1 0, 1 1, 0 0)'::geometry AS geom) AS foo;
st_isring | st_isclosed | st_issimple
-----------+-------------+-------------
f | t | f
(1 row)</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_IsClosed"/>, <xref linkend="ST_IsSimple"/>, <xref linkend="ST_StartPoint"/>,
<xref linkend="ST_EndPoint"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_IsSimple">
<refnamediv>
<refname>ST_IsSimple</refname>
<refpurpose>Tests if a geometry has no points of self-intersection or self-tangency.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>boolean <function>ST_IsSimple</function></funcdef>
<paramdef><type>geometry </type> <parameter>geomA</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Returns true if this Geometry has no anomalous geometric
points, such as self-intersection or self-tangency. For more
information on the OGC's definition of geometry simplicity and validity, refer
to <link linkend="OGC_Validity">"Ensuring OpenGIS compliance of geometries"</link></para>
<note>
<para>SQL-MM defines the result of ST_IsSimple(NULL) to be 0,
while PostGIS returns NULL.</para>
</note>
<para>&sfs_compliant; s2.1.1.1</para>
<para>&sqlmm_compliant; SQL-MM 3: 5.1.8</para>
<para>&Z_support;</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting> SELECT ST_IsSimple(ST_GeomFromText('POLYGON((1 2, 3 4, 5 6, 1 2))'));
st_issimple
-------------
f
(1 row)
SELECT ST_IsSimple(ST_GeomFromText('LINESTRING(1 1,2 2,2 3.5,1 3,1 2,2 1)'));
st_issimple
-------------
f
(1 row)</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_IsValid"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_M">
<refnamediv>
<refname>ST_M</refname>
<refpurpose>Returns the M coordinate of a Point.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>float <function>ST_M</function></funcdef>
<paramdef><type>geometry </type> <parameter>a_point</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Return the M coordinate of a Point, or NULL if not
available. Input must be a Point.</para>
<note>
<para>This is not (yet) part of the OGC spec, but is listed here
to complete the point coordinate extractor function list.</para>
</note>
<para>&sfs_compliant;</para>
<para>&sqlmm_compliant;</para>
<para>&Z_support;</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>SELECT ST_M(ST_GeomFromEWKT('POINT(1 2 3 4)'));
st_m
------
4
(1 row)
</programlisting>
</refsection>
<!-- Optionally add a "See Also" section -->
<refsection>
<title>See Also</title>
<para><xref linkend="ST_GeomFromEWKT"/>, <xref linkend="ST_X"/>, <xref linkend="ST_Y"/>, <xref linkend="ST_Z"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_MemSize">
<refnamediv>
<refname>ST_MemSize</refname>
<refpurpose>Returns the amount of memory space a geometry takes.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>integer <function>ST_MemSize</function></funcdef>
<paramdef><type>geometry </type> <parameter>geomA</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Returns the amount of memory space (in bytes) the geometry takes. </para>
<para>This complements the PostgreSQL built-in <link xlink:href="https://www.postgresql.org/docs/current/functions-admin.html#FUNCTIONS-ADMIN-DBOBJECT">database object functions</link>
pg_column_size, pg_size_pretty, pg_relation_size, pg_total_relation_size.</para>
<note><para>pg_relation_size which gives the byte size of a table may return byte size lower than ST_MemSize. This is because
pg_relation_size does not add toasted table contribution and large geometries are stored in TOAST tables.</para>
<para>pg_total_relation_size - includes, the table, the toasted tables, and the indexes.</para>
<para>pg_column_size returns how much space a geometry would take in a column considering compression, so may be lower than ST_MemSize</para>
</note>
<para>&Z_support;</para>
<para>&curve_support;</para>
<para>&P_support;</para>
<para>&T_support;</para>
<para role="changed" conformance="2.2.0">Changed: 2.2.0 name changed to ST_MemSize to follow naming convention.</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>
--Return how much byte space Boston takes up in our Mass data set
SELECT pg_size_pretty(SUM(ST_MemSize(geom))) as totgeomsum,
pg_size_pretty(SUM(CASE WHEN town = 'BOSTON' THEN ST_MemSize(geom) ELSE 0 END)) As bossum,
CAST(SUM(CASE WHEN town = 'BOSTON' THEN ST_MemSize(geom) ELSE 0 END)*1.00 /
SUM(ST_MemSize(geom))*100 As numeric(10,2)) As perbos
FROM towns;
totgeomsum bossum perbos
---------- ------ ------
1522 kB 30 kB 1.99
SELECT ST_MemSize(ST_GeomFromText('CIRCULARSTRING(220268 150415,220227 150505,220227 150406)'));
---
73
--What percentage of our table is taken up by just the geometry
SELECT pg_total_relation_size('public.neighborhoods') As fulltable_size, sum(ST_MemSize(geom)) As geomsize,
sum(ST_MemSize(geom))*1.00/pg_total_relation_size('public.neighborhoods')*100 As pergeom
FROM neighborhoods;
fulltable_size geomsize pergeom
------------------------------------------------
262144 96238 36.71188354492187500000
</programlisting>
</refsection>
</refentry>
<refentry xml:id="ST_NDims">
<refnamediv>
<refname>ST_NDims</refname>
<refpurpose>Returns the coordinate dimension of a geometry.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>integer <function>ST_NDims</function></funcdef>
<paramdef><type>geometry </type> <parameter>g1</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Returns the coordinate dimension of the geometry. PostGIS supports 2 - (x,y) ,
3 - (x,y,z) or 2D with measure - x,y,m, and 4 - 3D with measure space x,y,z,m</para>
<para>&Z_support;</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>SELECT ST_NDims(ST_GeomFromText('POINT(1 1)')) As d2point,
ST_NDims(ST_GeomFromEWKT('POINT(1 1 2)')) As d3point,
ST_NDims(ST_GeomFromEWKT('POINTM(1 1 0.5)')) As d2pointm;
d2point | d3point | d2pointm
---------+---------+----------
2 | 3 | 3
</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_CoordDim"/>, <xref linkend="ST_Dimension"/>, <xref linkend="ST_GeomFromEWKT"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_NPoints">
<refnamediv>
<refname>ST_NPoints</refname>
<refpurpose>Returns the number of points (vertices) in a geometry.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>integer <function>ST_NPoints</function></funcdef>
<paramdef><type>geometry </type> <parameter>g1</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Return the number of points in a geometry. Works for all geometries.</para>
<para role="enhanced" conformance="2.0.0">Enhanced: 2.0.0 support for Polyhedral surfaces was introduced.</para>
<note><para>Prior to 1.3.4, this function crashes if used with geometries that contain CURVES. This is fixed in 1.3.4+</para></note>
<para>&Z_support;</para>
<para>&curve_support;</para>
<para>&P_support;</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>SELECT ST_NPoints(ST_GeomFromText('LINESTRING(77.29 29.07,77.42 29.26,77.27 29.31,77.29 29.07)'));
--result
4
--Polygon in 3D space
SELECT ST_NPoints(ST_GeomFromEWKT('LINESTRING(77.29 29.07 1,77.42 29.26 0,77.27 29.31 -1,77.29 29.07 3)'))
--result
4</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_NumPoints"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_NRings">
<refnamediv>
<refname>ST_NRings</refname>
<refpurpose>Returns the number of rings in a polygonal geometry.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>integer <function>ST_NRings</function></funcdef>
<paramdef><type>geometry </type> <parameter>geomA</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>If the geometry is a polygon or multi-polygon returns the number of rings. Unlike NumInteriorRings, it counts
the outer rings as well.</para>
<para>&Z_support;</para>
<para>&curve_support;</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>SELECT ST_NRings(geom) As Nrings, ST_NumInteriorRings(geom) As ninterrings
FROM (SELECT ST_GeomFromText('POLYGON((1 2, 3 4, 5 6, 1 2))') As geom) As foo;
nrings | ninterrings
--------+-------------
1 | 0
(1 row)
</programlisting>
</refsection>
<!-- Optionally add a "See Also" section -->
<refsection>
<title>See Also</title>
<para><xref linkend="ST_NumInteriorRings"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_NumGeometries">
<refnamediv>
<refname>ST_NumGeometries</refname>
<refpurpose>Returns the number of elements in a geometry collection.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>integer <function>ST_NumGeometries</function></funcdef>
<paramdef><type>geometry </type> <parameter>geom</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Returns the number of elements in a geometry collection (GEOMETRYCOLLECTION or MULTI*).
For non-empty atomic geometries returns 1. For empty geometries returns 0.
</para>
<para role="enhanced" conformance="2.0.0">Enhanced: 2.0.0 support for Polyhedral surfaces, Triangles and TIN was introduced.</para>
<para role="changed" conformance="2.0.0">Changed: 2.0.0 In prior versions this would return NULL if the geometry was not a collection/MULTI type.
2.0.0+ now returns 1 for single geometries e.g POLYGON, LINESTRING, POINT.</para>
<para>&sqlmm_compliant; SQL-MM 3: 9.1.4</para>
<para>&Z_support;</para>
<para>&P_support;</para>
<para>&T_support;</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>
--Prior versions would have returned NULL for this -- in 2.0.0 this returns 1
SELECT ST_NumGeometries(ST_GeomFromText('LINESTRING(77.29 29.07,77.42 29.26,77.27 29.31,77.29 29.07)'));
--result
1
--Geometry Collection Example - multis count as one geom in a collection
SELECT ST_NumGeometries(ST_GeomFromEWKT('GEOMETRYCOLLECTION(MULTIPOINT((-2 3),(-2 2)),
LINESTRING(5 5 ,10 10),
POLYGON((-7 4.2,-7.1 5,-7.1 4.3,-7 4.2)))'));
--result
3
</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_GeometryN"/>, <xref linkend="ST_Multi"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_NumInteriorRings">
<refnamediv>
<refname>ST_NumInteriorRings</refname>
<refpurpose>Returns the number of interior rings (holes) of a Polygon.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>integer <function>ST_NumInteriorRings</function></funcdef>
<paramdef><type>geometry </type> <parameter>a_polygon</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>
Return the number of interior rings of a polygon geometry.
Return NULL if the geometry is not a polygon.
</para>
<para>&sqlmm_compliant; SQL-MM 3: 8.2.5</para>
<para role="changed" conformance="2.0.0">Changed: 2.0.0 - in prior versions it would allow passing a MULTIPOLYGON, returning the number of interior rings of first POLYGON.</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>
--If you have a regular polygon
SELECT gid, field1, field2, ST_NumInteriorRings(geom) AS numholes
FROM sometable;
--If you have multipolygons
--And you want to know the total number of interior rings in the MULTIPOLYGON
SELECT gid, field1, field2, SUM(ST_NumInteriorRings(geom)) AS numholes
FROM (SELECT gid, field1, field2, (ST_Dump(geom)).geom As geom
FROM sometable) As foo
GROUP BY gid, field1,field2;
</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_NumInteriorRing"/>, <xref linkend="ST_InteriorRingN"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_NumInteriorRing">
<refnamediv>
<refname>ST_NumInteriorRing</refname>
<refpurpose>Returns the number of interior rings (holes) of a Polygon. Aias for ST_NumInteriorRings</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>integer <function>ST_NumInteriorRing</function></funcdef>
<paramdef><type>geometry </type> <parameter>a_polygon</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_NumInteriorRings"/>, <xref linkend="ST_InteriorRingN"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_NumPatches">
<refnamediv>
<refname>ST_NumPatches</refname>
<refpurpose>Return the number of faces on a Polyhedral Surface. Will return null for non-polyhedral geometries.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>integer <function>ST_NumPatches</function></funcdef>
<paramdef><type>geometry </type> <parameter>g1</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Return the number of faces on a Polyhedral Surface. Will return null for non-polyhedral geometries. This is
an alias for ST_NumGeometries to support MM naming. Faster to use ST_NumGeometries if you don't care about MM convention.</para>
<para role="availability" conformance="2.0.0">Availability: 2.0.0</para>
<para>&Z_support;</para>
<para>&sfs_compliant;</para>
<para>&sqlmm_compliant; SQL-MM ISO/IEC 13249-3: 8.5</para>
<para>&P_support;</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>SELECT ST_NumPatches(ST_GeomFromEWKT('POLYHEDRALSURFACE( ((0 0 0, 0 0 1, 0 1 1, 0 1 0, 0 0 0)),
((0 0 0, 0 1 0, 1 1 0, 1 0 0, 0 0 0)), ((0 0 0, 1 0 0, 1 0 1, 0 0 1, 0 0 0)),
((1 1 0, 1 1 1, 1 0 1, 1 0 0, 1 1 0)),
((0 1 0, 0 1 1, 1 1 1, 1 1 0, 0 1 0)), ((0 0 1, 1 0 1, 1 1 1, 0 1 1, 0 0 1)) )'));
--result
6
</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_GeomFromEWKT"/>, <xref linkend="ST_NumGeometries"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_NumPoints">
<refnamediv>
<refname>ST_NumPoints</refname>
<refpurpose>Returns the number of points in a LineString or CircularString.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>integer <function>ST_NumPoints</function></funcdef>
<paramdef><type>geometry </type> <parameter>g1</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Return the number of points in an ST_LineString or
ST_CircularString value. Prior to 1.4 only works with linestrings as the specs state. From 1.4 forward this is an alias for ST_NPoints which returns number of vertices for
not just linestrings.
Consider using ST_NPoints instead which is multi-purpose
and works with many geometry types.</para>
<para>&sfs_compliant;</para>
<para>&sqlmm_compliant; SQL-MM 3: 7.2.4</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>SELECT ST_NumPoints(ST_GeomFromText('LINESTRING(77.29 29.07,77.42 29.26,77.27 29.31,77.29 29.07)'));
--result
4
</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_NPoints"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_PatchN">
<refnamediv>
<refname>ST_PatchN</refname>
<refpurpose>Returns the Nth geometry (face) of a PolyhedralSurface.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_PatchN</function></funcdef>
<paramdef><type>geometry </type> <parameter>geomA</parameter></paramdef>
<paramdef><type>integer </type> <parameter>n</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Returns the 1-based Nth geometry (face) if the geometry is a
POLYHEDRALSURFACE or POLYHEDRALSURFACEM.
Otherwise, returns NULL.
This returns the same answer as ST_GeometryN for PolyhedralSurfaces.
Using ST_GeometryN is faster.</para>
<note>
<para>Index is 1-based.</para>
</note>
<note>
<para>If you want to extract all elements of a geometry <xref linkend="ST_Dump"/> is more efficient.</para>
</note>
<para role="availability" conformance="2.0.0">Availability: 2.0.0</para>
<para>&sqlmm_compliant; SQL-MM ISO/IEC 13249-3: 8.5</para>
<para>&Z_support;</para>
<para>&P_support;</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>
--Extract the 2nd face of the polyhedral surface
SELECT ST_AsEWKT(ST_PatchN(geom, 2)) As geomewkt
FROM (
VALUES (ST_GeomFromEWKT('POLYHEDRALSURFACE( ((0 0 0, 0 0 1, 0 1 1, 0 1 0, 0 0 0)),
((0 0 0, 0 1 0, 1 1 0, 1 0 0, 0 0 0)), ((0 0 0, 1 0 0, 1 0 1, 0 0 1, 0 0 0)),
((1 1 0, 1 1 1, 1 0 1, 1 0 0, 1 1 0)),
((0 1 0, 0 1 1, 1 1 1, 1 1 0, 0 1 0)), ((0 0 1, 1 0 1, 1 1 1, 0 1 1, 0 0 1)) )')) ) As foo(geom);
geomewkt
---+-----------------------------------------
POLYGON((0 0 0,0 1 0,1 1 0,1 0 0,0 0 0))
</programlisting>
</refsection>
<!-- Optionally add a "See Also" section -->
<refsection>
<title>See Also</title>
<para><xref linkend="ST_AsEWKT"/>, <xref linkend="ST_GeomFromEWKT"/>, <xref linkend="ST_Dump"/>, <xref linkend="ST_GeometryN"/>, <xref linkend="ST_NumGeometries"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_PointN">
<refnamediv>
<refname>ST_PointN</refname>
<refpurpose>Returns the Nth point in the first LineString or circular LineString in a
geometry. </refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_PointN</function></funcdef>
<paramdef><type>geometry </type> <parameter>a_linestring</parameter></paramdef>
<paramdef><type>integer </type> <parameter>n</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Return the Nth point in a single linestring or circular linestring in the
geometry. Negative values are counted backwards from the end of the LineString, so that -1 is the last point. Returns NULL if there is no linestring in the
geometry.</para>
<note>
<para>Index is 1-based as for OGC specs since version 0.8.0.
Backward indexing (negative index) is not in OGC
Previous versions implemented this as 0-based instead.</para>
</note>
<note>
<para>If you want to get the Nth point of each LineString in a MultiLineString, use in conjunction
with ST_Dump</para>
</note>
<para>&sfs_compliant;</para>
<para>&sqlmm_compliant; SQL-MM 3: 7.2.5, 7.3.5</para>
<para>&Z_support;</para>
<para>&curve_support;</para>
<note><para role="changed" conformance="2.0.0">Changed: 2.0.0 no longer works with single geometry multilinestrings. In older
versions of PostGIS -- a single line multilinestring would work happily with this
function and return the start point. In 2.0.0 it just returns NULL like any other multilinestring.</para>
<para role="changed" conformance="2.3.0"> Changed: 2.3.0 : negative indexing available (-1 is last point)
</para>
</note>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>-- Extract all POINTs from a LINESTRING
SELECT ST_AsText(
ST_PointN(
column1,
generate_series(1, ST_NPoints(column1))
))
FROM ( VALUES ('LINESTRING(0 0, 1 1, 2 2)'::geometry) ) AS foo;
st_astext
------------
POINT(0 0)
POINT(1 1)
POINT(2 2)
(3 rows)
--Example circular string
SELECT ST_AsText(ST_PointN(ST_GeomFromText('CIRCULARSTRING(1 2, 3 2, 1 2)'), 2));
st_astext
------------
POINT(3 2)
(1 row)
SELECT ST_AsText(f)
FROM ST_GeomFromText('LINESTRING(0 0 0, 1 1 1, 2 2 2)') AS g
,ST_PointN(g, -2) AS f; -- 1 based index
st_astext
-----------------
POINT Z (1 1 1)
(1 row)
</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_NPoints"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_Points">
<refnamediv>
<refname>ST_Points</refname>
<refpurpose>Returns a MultiPoint containing the coordinates of a geometry.
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_Points</function></funcdef>
<paramdef>
<type>geometry</type>
<parameter>geom</parameter>
</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>
Returns a MultiPoint containing all the coordinates of a geometry.
Duplicate points are preserved,
including the start and end points of ring geometries.
(If desired, duplicate points can be removed by calling
<xref linkend="ST_RemoveRepeatedPoints"/> on the result).
</para>
<para>
To obtain information about the position of each coordinate in the parent geometry
use <xref linkend="ST_DumpPoints"/>.
</para>
<para>
M and Z coordinates are preserved if present.
</para>
<para>&curve_support;</para>
<para>&Z_support;</para>
<para role="availability" conformance="2.3.0">Availability: 2.3.0</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>SELECT ST_AsText(ST_Points('POLYGON Z ((30 10 4,10 30 5,40 40 6, 30 10))'));
--result
MULTIPOINT Z ((30 10 4),(10 30 5),(40 40 6),(30 10 4))
</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_RemoveRepeatedPoints"/>, <xref linkend="ST_DumpPoints"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_StartPoint">
<refnamediv>
<refname>ST_StartPoint</refname>
<refpurpose>Returns the first point of a LineString.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_StartPoint</function></funcdef>
<paramdef><type>geometry </type> <parameter>geomA</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Returns the first point of a <varname>LINESTRING</varname>
or <varname>CIRCULARLINESTRING</varname> geometry
as a <varname>POINT</varname>.
Returns <varname>NULL</varname> if the input
is not a <varname>LINESTRING</varname> or <varname>CIRCULARLINESTRING</varname>.</para>
<para>&sqlmm_compliant; SQL-MM 3: 7.1.3</para>
<para>&Z_support;</para>
<para>&curve_support;</para>
<note>
<para role="enhanced" conformance="3.2.0">Enhanced: 3.2.0 returns a point for all geometries. Prior behavior returns NULLs if input was not a LineString.</para>
<para role="changed" conformance="2.0.0">Changed: 2.0.0 no longer works with single geometry MultiLineStrings. In older
versions of PostGIS a single-line MultiLineString would work happily with this
function and return the start point. In 2.0.0 it just returns NULL like any other MultiLineString.
The old behavior was an undocumented feature, but people who assumed they had their data stored as LINESTRING
may experience these returning NULL in 2.0.0.</para>
</note>
</refsection>
<refsection>
<title>Examples</title>
<para>Start point of a LineString</para>
<programlisting>SELECT ST_AsText(ST_StartPoint('LINESTRING(0 1, 0 2)'::geometry));
st_astext
------------
POINT(0 1)
</programlisting>
<para>Start point of a non-LineString is NULL</para>
<programlisting>
SELECT ST_StartPoint('POINT(0 1)'::geometry) IS NULL AS is_null;
is_null
----------
t
</programlisting>
<para>Start point of a 3D LineString</para>
<programlisting>
SELECT ST_AsEWKT(ST_StartPoint('LINESTRING(0 1 1, 0 2 2)'::geometry));
st_asewkt
------------
POINT(0 1 1)
</programlisting>
<para>Start point of a CircularString</para>
<programlisting>
SELECT ST_AsText(ST_StartPoint('CIRCULARSTRING(5 2,-3 1.999999, -2 1, -4 2, 6 3)'::geometry));
st_astext
------------
POINT(5 2)
</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_EndPoint"/>, <xref linkend="ST_PointN"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_Summary">
<refnamediv>
<refname>ST_Summary</refname>
<refpurpose>Returns a text summary of the contents of a geometry.
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>text <function>ST_Summary</function></funcdef>
<paramdef><type>geometry </type> <parameter>g</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>text <function>ST_Summary</function></funcdef>
<paramdef><type>geography </type> <parameter>g</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Returns a text summary of the contents of the geometry.</para>
<para>
Flags shown square brackets after the geometry type
have the following meaning:
<itemizedlist>
<listitem><para>M: has M coordinate</para></listitem>
<listitem><para>Z: has Z coordinate</para></listitem>
<listitem><para>B: has a cached bounding box</para></listitem>
<listitem><para>G: is geodetic (geography)</para></listitem>
<listitem><para>S: has spatial reference system</para></listitem>
</itemizedlist>
</para>
<!-- Optionally mention Circular String Support -->
<para>&curve_support;</para>
<!-- Optionally mention supports Polyhedral Surface -->
<para>&P_support;</para>
<!-- Optionally mention support for Triangles and TINS -->
<para>&T_support;</para>
<para role="availability" conformance="1.2.2">Availability: 1.2.2</para>
<para role="enhanced" conformance="2.0.0">Enhanced: 2.0.0 added support for geography</para>
<para role="enhanced" conformance="2.1.0">Enhanced: 2.1.0 S flag to denote if has a known spatial reference system</para>
<para role="enhanced" conformance="2.2.0">Enhanced: 2.2.0 Added support for TIN and Curves</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>
=# SELECT ST_Summary(ST_GeomFromText('LINESTRING(0 0, 1 1)')) as geom,
ST_Summary(ST_GeogFromText('POLYGON((0 0, 1 1, 1 2, 1 1, 0 0))')) geog;
geom | geog
-----------------------------+--------------------------
LineString[B] with 2 points | Polygon[BGS] with 1 rings
| ring 0 has 5 points
:
(1 row)
=# SELECT ST_Summary(ST_GeogFromText('LINESTRING(0 0 1, 1 1 1)')) As geog_line,
ST_Summary(ST_GeomFromText('SRID=4326;POLYGON((0 0 1, 1 1 2, 1 2 3, 1 1 1, 0 0 1))')) As geom_poly;
;
geog_line | geom_poly
-------------------------------- +--------------------------
LineString[ZBGS] with 2 points | Polygon[ZBS] with 1 rings
: ring 0 has 5 points
:
(1 row)
</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para>
<xref linkend="PostGIS_DropBBox"/>,
<xref linkend="PostGIS_AddBBox"/>,
<xref linkend="ST_Force_3DM"/>,
<xref linkend="ST_Force_3DZ"/>,
<xref linkend="ST_Force2D"/>,
<xref linkend="geography"/>
</para>
<para>
<xref linkend="ST_IsValid"/>,
<xref linkend="ST_IsValid"/>,
<xref linkend="ST_IsValidReason"/>,
<xref linkend="ST_IsValidDetail"/>
</para>
</refsection>
</refentry>
<refentry xml:id="ST_X">
<refnamediv>
<refname>ST_X</refname>
<refpurpose>Returns the X coordinate of a Point.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>float <function>ST_X</function></funcdef>
<paramdef><type>geometry </type> <parameter>a_point</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Return the X coordinate of the point, or NULL if not
available. Input must be a point.</para>
<note><para>To get the minimum and maximum X value of geometry coordinates use the functions
<xref linkend="ST_XMin"/> and <xref linkend="ST_XMax"/>.</para></note>
<para>&sqlmm_compliant; SQL-MM 3: 6.1.3</para>
<para>&Z_support;</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>SELECT ST_X(ST_GeomFromEWKT('POINT(1 2 3 4)'));
st_x
------
1
(1 row)
SELECT ST_Y(ST_Centroid(ST_GeomFromEWKT('LINESTRING(1 2 3 4, 1 1 1 1)')));
st_y
------
1.5
(1 row)
</programlisting>
</refsection>
<!-- Optionally add a "See Also" section -->
<refsection>
<title>See Also</title>
<para><xref linkend="ST_Centroid"/>, <xref linkend="ST_GeomFromEWKT"/>, <xref linkend="ST_M"/>, <xref linkend="ST_XMax"/>, <xref linkend="ST_XMin"/>, <xref linkend="ST_Y"/>, <xref linkend="ST_Z"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_Y">
<refnamediv>
<refname>ST_Y</refname>
<refpurpose>Returns the Y coordinate of a Point.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>float <function>ST_Y</function></funcdef>
<paramdef><type>geometry </type> <parameter>a_point</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Return the Y coordinate of the point, or NULL if not
available. Input must be a point.</para>
<note><para>To get the minimum and maximum Y value of geometry coordinates use the functions
<xref linkend="ST_YMin"/> and <xref linkend="ST_YMax"/>.</para></note>
<para>&sfs_compliant;</para>
<para>&sqlmm_compliant; SQL-MM 3: 6.1.4</para>
<para>&Z_support;</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>SELECT ST_Y(ST_GeomFromEWKT('POINT(1 2 3 4)'));
st_y
------
2
(1 row)
SELECT ST_Y(ST_Centroid(ST_GeomFromEWKT('LINESTRING(1 2 3 4, 1 1 1 1)')));
st_y
------
1.5
(1 row)
</programlisting>
</refsection>
<!-- Optionally add a "See Also" section -->
<refsection>
<title>See Also</title>
<para><xref linkend="ST_Centroid"/>, <xref linkend="ST_GeomFromEWKT"/>, <xref linkend="ST_M"/>, <xref linkend="ST_X"/>, <xref linkend="ST_YMax"/>, <xref linkend="ST_YMin"/>, <xref linkend="ST_Z"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_Z">
<refnamediv>
<refname>ST_Z</refname>
<refpurpose>Returns the Z coordinate of a Point.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>float <function>ST_Z</function></funcdef>
<paramdef><type>geometry </type> <parameter>a_point</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Return the Z coordinate of the point, or NULL if not
available. Input must be a point.</para>
<note><para>To get the minimum and maximum Z value of geometry coordinates use the functions
<xref linkend="ST_ZMin"/> and <xref linkend="ST_ZMax"/>.</para></note>
<para>&sqlmm_compliant;</para>
<para>&Z_support;</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>SELECT ST_Z(ST_GeomFromEWKT('POINT(1 2 3 4)'));
st_z
------
3
(1 row)
</programlisting>
</refsection>
<!-- Optionally add a "See Also" section -->
<refsection>
<title>See Also</title>
<para><xref linkend="ST_GeomFromEWKT"/>, <xref linkend="ST_M"/>, <xref linkend="ST_X"/>, <xref linkend="ST_Y"/>, <xref linkend="ST_ZMax"/>, <xref linkend="ST_ZMin"/> </para>
</refsection>
</refentry>
<refentry xml:id="ST_Zmflag">
<refnamediv>
<refname>ST_Zmflag</refname>
<refpurpose>Returns a code indicating the ZM coordinate dimension of a geometry.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>smallint <function>ST_Zmflag</function></funcdef>
<paramdef><type>geometry </type> <parameter>geomA</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Returns a code indicating the ZM coordinate dimension of a geometry. </para>
<para>Values are: 0 = 2D, 1 = 3D-M, 2 = 3D-Z, 3 = 4D.</para>
<para>&Z_support;</para>
<para>&curve_support;</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>SELECT ST_Zmflag(ST_GeomFromEWKT('LINESTRING(1 2, 3 4)'));
st_zmflag
-----------
0
SELECT ST_Zmflag(ST_GeomFromEWKT('LINESTRINGM(1 2 3, 3 4 3)'));
st_zmflag
-----------
1
SELECT ST_Zmflag(ST_GeomFromEWKT('CIRCULARSTRING(1 2 3, 3 4 3, 5 6 3)'));
st_zmflag
-----------
2
SELECT ST_Zmflag(ST_GeomFromEWKT('POINT(1 2 3 4)'));
st_zmflag
-----------
3
</programlisting>
</refsection>
<!-- Optionally add a "See Also" section -->
<refsection>
<title>See Also</title>
<para><xref linkend="ST_CoordDim"/>, <xref linkend="ST_NDims"/>, <xref linkend="ST_Dimension"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_HasZ">
<refnamediv>
<refname>ST_HasZ</refname>
<refpurpose>Checks if a geometry has a Z dimension.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>boolean <function>ST_HasZ</function></funcdef>
<paramdef><type>geometry</type> <parameter>geom</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Checks if the input geometry has a Z dimension and returns a boolean value. If the geometry has a Z dimension, it returns true; otherwise, it returns false.</para>
<para>Geometry objects with a Z dimension typically represent three-dimensional (3D) geometries, while those without it are two-dimensional (2D) geometries.</para>
<para>This function is useful for determining if a geometry has elevation or height information.</para>
<para role="availability" conformance="3.5.0">Availability: 3.5.0</para>
<para>&Z_support;</para>
<para>&M_support;</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>SELECT ST_HasZ(ST_GeomFromText('POINT(1 2 3)'));
--result
true
</programlisting>
<programlisting>SELECT ST_HasZ(ST_GeomFromText('LINESTRING(0 0, 1 1)'));
--result
false
</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_Zmflag"/></para>
<para><xref linkend="ST_HasM"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_HasM">
<refnamediv>
<refname>ST_HasM</refname>
<refpurpose>Checks if a geometry has an M (measure) dimension.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>boolean <function>ST_HasM</function></funcdef>
<paramdef><type>geometry</type> <parameter>geom</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Checks if the input geometry has an M (measure) dimension and returns a boolean value. If the geometry has an M dimension, it returns true; otherwise, it returns false.</para>
<para>Geometry objects with an M dimension typically represent measurements or additional data associated with spatial features.</para>
<para>This function is useful for determining if a geometry includes measure information.</para>
<para role="availability" conformance="3.5.0">Availability: 3.5.0</para>
<para>&Z_support;</para>
<para>&M_support;</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>SELECT ST_HasM(ST_GeomFromText('POINTM(1 2 3)'));
--result
true
</programlisting>
<programlisting>SELECT ST_HasM(ST_GeomFromText('LINESTRING(0 0, 1 1)'));
--result
false
</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_Zmflag"/></para>
<para><xref linkend="ST_HasZ"/></para>
</refsection>
</refentry>
</section>
|