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
|
<!-- 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_Outputs">
<title>Geometry Output</title><info>
<abstract>
<para>These functions convert geometry objects into various textual or binary formats.</para>
</abstract>
</info>
<section>
<title>Well-Known Text (WKT)</title>
<refentry xml:id="ST_AsEWKT">
<refnamediv>
<refname>ST_AsEWKT</refname>
<refpurpose>Return the Well-Known Text (WKT) representation of the geometry with SRID meta data.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>text <function>ST_AsEWKT</function></funcdef>
<paramdef><type>geometry </type> <parameter>g1</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>text <function>ST_AsEWKT</function></funcdef>
<paramdef><type>geometry </type> <parameter>g1</parameter></paramdef>
<paramdef choice="opt"><type>integer </type> <parameter>maxdecimaldigits=15</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>text <function>ST_AsEWKT</function></funcdef>
<paramdef><type>geography </type> <parameter>g1</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>text <function>ST_AsEWKT</function></funcdef>
<paramdef><type>geography </type> <parameter>g1</parameter></paramdef>
<paramdef choice="opt"><type>integer </type> <parameter>maxdecimaldigits=15</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Returns the Well-Known Text representation of the geometry prefixed with the SRID.
The optional <parameter>maxdecimaldigits</parameter> argument may be used to reduce the maximum number
of decimal digits after floating point used in output (defaults to 15).</para>
<para>To perform the inverse conversion of EWKT representation to PostGIS geometry
use <xref linkend="ST_GeomFromEWKT"/>.</para>
<warning>
<para>Using the <parameter>maxdecimaldigits</parameter> parameter
can cause output geometry to become invalid.
To avoid this use <xref linkend="ST_ReducePrecision"/>
with a suitable gridsize first.
</para>
</warning>
<note>
<para>The WKT spec does not include the SRID. To get the OGC WKT format use <xref linkend="ST_AsText"/>.</para>
</note>
<warning>
<para>WKT format does not maintain precision so to prevent floating truncation,
use <xref linkend="ST_AsBinary"/> or <xref linkend="ST_AsEWKB"/> format for transport.</para>
</warning>
<para role="enhanced" conformance="3.1.0">Enhanced: 3.1.0 support for optional precision parameter.</para>
<para role="enhanced" conformance="2.0.0">Enhanced: 2.0.0 support for Geography, Polyhedral surfaces, Triangles and TIN was introduced.</para>
<para>&Z_support;</para>
<para>&curve_support;</para>
<para>&P_support;</para>
<para>&T_support;</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>SELECT ST_AsEWKT('0103000020E61000000100000005000000000000
000000000000000000000000000000000000000000000000000000
F03F000000000000F03F000000000000F03F000000000000F03
F000000000000000000000000000000000000000000000000'::geometry);
st_asewkt
--------------------------------
SRID=4326;POLYGON((0 0,0 1,1 1,1 0,0 0))
(1 row)
SELECT ST_AsEWKT('0108000080030000000000000060E30A4100000000785C0241000000000000F03F0000000018
E20A4100000000485F024100000000000000400000000018
E20A4100000000305C02410000000000000840')
--st_asewkt---
CIRCULARSTRING(220268 150415 1,220227 150505 2,220227 150406 3)
</programlisting>
</refsection>
<!-- Optionally add a "See Also" section -->
<refsection>
<title>See Also</title>
<para>
<xref linkend="ST_AsBinary"/>,
<xref linkend="ST_AsEWKB"/>,
<xref linkend="ST_AsText"/>,
<xref linkend="ST_GeomFromEWKT"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_AsText">
<refnamediv>
<refname>ST_AsText</refname>
<refpurpose>Return the Well-Known Text (WKT) representation of the geometry/geography without SRID metadata.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>text <function>ST_AsText</function></funcdef>
<paramdef><type>geometry </type> <parameter>g1</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>text <function>ST_AsText</function></funcdef>
<paramdef><type>geometry </type> <parameter>g1</parameter></paramdef>
<paramdef choice="opt"><type>integer </type> <parameter>maxdecimaldigits = 15</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>text <function>ST_AsText</function></funcdef>
<paramdef><type>geography </type> <parameter>g1</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>text <function>ST_AsText</function></funcdef>
<paramdef><type>geography </type> <parameter>g1</parameter></paramdef>
<paramdef choice="opt"><type>integer </type> <parameter>maxdecimaldigits = 15</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Returns the OGC <link linkend="OpenGISWKBWKT">Well-Known Text</link> (WKT) representation of the geometry/geography.
The optional <parameter>maxdecimaldigits</parameter> argument may be used to limit the number
of digits after the decimal point in output ordinates (defaults to 15).</para>
<para>To perform the inverse conversion of WKT representation to PostGIS geometry
use <xref linkend="ST_GeomFromText"/>.</para>
<note>
<para>The standard OGC WKT representation does not include the SRID.
To include the SRID as part of the output representation, use the non-standard
PostGIS function <xref linkend="ST_AsEWKT"/></para>
</note>
<warning>
<para>The textual representation of numbers in WKT may not maintain full floating-point precision.
To ensure full accuracy for data storage or transport it is best to use
<link linkend="OpenGISWKBWKT">Well-Known Binary</link> (WKB) format
(see <xref linkend="ST_AsBinary"/> and <parameter>maxdecimaldigits</parameter>).</para>
</warning>
<warning>
<para>Using the <parameter>maxdecimaldigits</parameter> parameter
can cause output geometry to become invalid.
To avoid this use <xref linkend="ST_ReducePrecision"/>
with a suitable gridsize first.
</para>
</warning>
<para role="availability" conformance="1.5">Availability: 1.5 - support for geography was introduced.</para>
<para role="enhanced" conformance="2.5">Enhanced: 2.5 - optional parameter precision introduced.</para>
<para>&sfs_compliant; s2.1.1.1</para>
<para>&sqlmm_compliant; SQL-MM 3: 5.1.25</para>
<para>&curve_support;</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>SELECT ST_AsText('01030000000100000005000000000000000000
000000000000000000000000000000000000000000000000
F03F000000000000F03F000000000000F03F000000000000F03
F000000000000000000000000000000000000000000000000');
st_astext
--------------------------------
POLYGON((0 0,0 1,1 1,1 0,0 0))
</programlisting>
<para>Full precision output is the default.</para>
<programlisting>SELECT ST_AsText('POINT(111.1111111 1.1111111)'));
st_astext
------------------------------
POINT(111.1111111 1.1111111)
</programlisting>
<para>The <parameter>maxdecimaldigits</parameter> argument can be used to limit output precision.</para>
<programlisting>SELECT ST_AsText('POINT(111.1111111 1.1111111)'), 2);
st_astext
--------------------
POINT(111.11 1.11)
</programlisting>
</refsection>
<!-- Optionally add a "See Also" section -->
<refsection>
<title>See Also</title>
<para><xref linkend="ST_AsBinary"/>, <xref linkend="ST_AsEWKB"/>, <xref linkend="ST_AsEWKT"/>, <xref linkend="ST_GeomFromText"/></para>
</refsection>
</refentry>
</section>
<!-- ============================================================================== -->
<section>
<title>Well-Known Binary (WKB)</title>
<refentry xml:id="ST_AsBinary">
<refnamediv>
<refname>ST_AsBinary</refname>
<refpurpose>Return the OGC/ISO Well-Known Binary (WKB) representation of the geometry/geography without SRID meta data.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>bytea <function>ST_AsBinary</function></funcdef>
<paramdef><type>geometry </type> <parameter>g1</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>bytea <function>ST_AsBinary</function></funcdef>
<paramdef><type>geometry </type> <parameter>g1</parameter></paramdef>
<paramdef><type>text </type><parameter>NDR_or_XDR</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>bytea <function>ST_AsBinary</function></funcdef>
<paramdef><type>geography </type> <parameter>g1</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>bytea <function>ST_AsBinary</function></funcdef>
<paramdef><type>geography </type> <parameter>g1</parameter></paramdef>
<paramdef><type>text </type><parameter>NDR_or_XDR</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Returns the OGC/ISO <link linkend="OpenGISWKBWKT">Well-Known Binary</link> (WKB) representation of the geometry.
The first function variant defaults to encoding using server machine endian.
The second function variant takes a text argument
specifying the endian encoding, either little-endian ('NDR') or big-endian ('XDR').</para>
<para>WKB format is useful to read geometry data from the
database and maintaining full numeric precision.
This avoids the precision rounding that can happen with text formats such as WKT.</para>
<para>To perform the inverse conversion of WKB to PostGIS geometry use <xref linkend="ST_GeomFromWKB"/>.</para>
<note>
<para>The OGC/ISO WKB format does not include the SRID. To get the EWKB format which does include the SRID use <xref linkend="ST_AsEWKB"/></para>
</note>
<note>
<para>The default behavior in PostgreSQL 9.0 has been changed to output bytea in hex encoding.
If your GUI tools require the old behavior, then SET bytea_output='escape' in your database.</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="enhanced" conformance="2.0.0">Enhanced: 2.0.0 support for higher coordinate dimensions was introduced.</para>
<para role="enhanced" conformance="2.0.0">Enhanced: 2.0.0 support for specifying endian with geography was introduced.</para>
<para role="availability" conformance="1.5.0">Availability: 1.5.0 geography support was introduced.</para>
<para role="changed" conformance="2.0.0">Changed: 2.0.0 Inputs to this function can not be unknown -- must be geometry. Constructs such as <code>ST_AsBinary('POINT(1 2)')</code> are no longer valid and you will get an <code>n st_asbinary(unknown) is not unique error</code>. Code like that
needs to be changed to <code>ST_AsBinary('POINT(1 2)'::geometry);</code>. If that is not possible, then install <filename>legacy.sql</filename>.</para>
<para>&sfs_compliant; s2.1.1.1</para>
<para>&sqlmm_compliant; SQL-MM 3: 5.1.37</para>
<para>&curve_support;</para>
<para>&P_support;</para>
<para>&T_support;</para>
<para>&Z_support;</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>SELECT ST_AsBinary(ST_GeomFromText('POLYGON((0 0,0 1,1 1,1 0,0 0))',4326));
st_asbinary
--------------------------------
\x01030000000100000005000000000000000000000000000000000000000000000000000000000000
000000f03f000000000000f03f000000000000f03f000000000000f03f0000000000000000000000
00000000000000000000000000
</programlisting>
<programlisting>SELECT ST_AsBinary(ST_GeomFromText('POLYGON((0 0,0 1,1 1,1 0,0 0))',4326), 'XDR');
st_asbinary
--------------------------------
\x000000000300000001000000050000000000000000000000000000000000000000000000003ff000
00000000003ff00000000000003ff00000000000003ff00000000000000000000000000000000000
00000000000000000000000000
</programlisting>
</refsection>
<!-- Optionally add a "See Also" section -->
<refsection>
<title>See Also</title>
<para>
<xref linkend="ST_GeomFromWKB"/>,
<xref linkend="ST_AsEWKB"/>,
<xref linkend="ST_AsTWKB"/>,
<xref linkend="ST_AsText"/>,
</para>
</refsection>
</refentry>
<refentry xml:id="ST_AsEWKB">
<refnamediv>
<refname>ST_AsEWKB</refname>
<refpurpose>Return the Extended Well-Known Binary (EWKB) representation of the geometry with SRID meta data.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>bytea <function>ST_AsEWKB</function></funcdef>
<paramdef><type>geometry </type> <parameter>g1</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>bytea <function>ST_AsEWKB</function></funcdef>
<paramdef><type>geometry </type> <parameter>g1</parameter></paramdef>
<paramdef><type>text </type><parameter>NDR_or_XDR</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Returns the <link linkend="EWKB_EWKT">Extended Well-Known Binary</link> (EWKB) representation of the geometry with SRID metadata.
The first function variant defaults to encoding using server machine endian.
The second function variant takes a text argument
specifying the endian encoding, either little-endian ('NDR') or big-endian ('XDR').</para>
<para>WKB format is useful to read geometry data from the
database and maintaining full numeric precision.
This avoids the precision rounding that can happen with text formats such as WKT.</para>
<para>To perform the inverse conversion of EWKB to PostGIS geometry use <xref linkend="ST_GeomFromEWKB"/>.</para>
<note>
<para>To get the OGC/ISO WKB format use <xref linkend="ST_AsBinary"/>.
Note that OGC/ISO WKB format does not include the SRID. </para>
</note>
<para role="enhanced" conformance="2.0.0">Enhanced: 2.0.0 support for Polyhedral surfaces, Triangles and TIN was introduced.</para>
<para>&Z_support;</para>
<para>&curve_support;</para>
<para>&P_support;</para>
<para>&T_support;</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>SELECT ST_AsEWKB(ST_GeomFromText('POLYGON((0 0,0 1,1 1,1 0,0 0))',4326));
st_asewkb
--------------------------------
\x0103000020e610000001000000050000000000000000000000000000000000000000000000000000
00000000000000f03f000000000000f03f000000000000f03f000000000000f03f00000000000000
0000000000000000000000000000000000
</programlisting>
<programlisting>
SELECT ST_AsEWKB(ST_GeomFromText('POLYGON((0 0,0 1,1 1,1 0,0 0))',4326), 'XDR');
st_asewkb
--------------------------------
\x0020000003000010e600000001000000050000000000000000000000000000000000000000000000
003ff00000000000003ff00000000000003ff00000000000003ff000000000000000000000000000
0000000000000000000000000000000000
</programlisting>
</refsection>
<!-- Optionally add a "See Also" section -->
<refsection>
<title>See Also</title>
<para><xref linkend="ST_AsBinary"/>, <xref linkend="ST_GeomFromEWKB"/>, <xref linkend="ST_SRID"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_AsHEXEWKB">
<refnamediv>
<refname>ST_AsHEXEWKB</refname>
<refpurpose>Returns a Geometry in HEXEWKB format (as text) using either
little-endian (NDR) or big-endian (XDR) encoding.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>text <function>ST_AsHEXEWKB</function></funcdef>
<paramdef><type>geometry </type> <parameter>g1</parameter></paramdef>
<paramdef><type>text </type> <parameter>NDRorXDR</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>text <function>ST_AsHEXEWKB</function></funcdef>
<paramdef><type>geometry </type> <parameter>g1</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Returns a Geometry in HEXEWKB format (as text) using either
little-endian (NDR) or big-endian (XDR) encoding. If no encoding is specified, then NDR is used.</para>
<note>
<para role="availability" conformance="1.2.2">Availability: 1.2.2</para>
</note>
<para>&Z_support;</para>
<para>&curve_support;</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>SELECT ST_AsHEXEWKB(ST_GeomFromText('POLYGON((0 0,0 1,1 1,1 0,0 0))',4326));
which gives same answer as
SELECT ST_GeomFromText('POLYGON((0 0,0 1,1 1,1 0,0 0))',4326)::text;
st_ashexewkb
--------
0103000020E6100000010000000500
00000000000000000000000000000000
00000000000000000000000000000000F03F
000000000000F03F000000000000F03F000000000000F03
F000000000000000000000000000000000000000000000000</programlisting>
</refsection>
</refentry>
</section>
<!-- ============================================================================== -->
<section>
<title>Other Formats</title>
<refentry xml:id="ST_AsEncodedPolyline">
<refnamediv>
<refname>ST_AsEncodedPolyline</refname>
<refpurpose>Returns an Encoded Polyline from a LineString geometry.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>text <function>ST_AsEncodedPolyline</function></funcdef>
<paramdef><type>geometry</type> <parameter>geom</parameter></paramdef>
<paramdef choice="opt"><type>integer </type> <parameter>precision=5</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Returns the geometry as an Encoded Polyline. This format is used by Google Maps with precision=5 and by Open Source Routing Machine with precision=5 and 6.</para>
<para>Optional <varname>precision</varname> specifies how many decimal places will be preserved in Encoded Polyline. Value should be the same on encoding and decoding, or coordinates will be incorrect.</para>
<para role="availability" conformance="2.2.0">Availability: 2.2.0</para>
</refsection>
<refsection>
<title>Examples</title>
<para>Basic </para>
<programlisting>
SELECT ST_AsEncodedPolyline(GeomFromEWKT('SRID=4326;LINESTRING(-120.2 38.5,-120.95 40.7,-126.453 43.252)'));
--result--
|_p~iF~ps|U_ulLnnqC_mqNvxq`@
</programlisting>
<para>Use in conjunction with geography linestring and geography segmentize, and put on google maps</para>
<programlisting>-- the SQL for Boston to San Francisco, segments every 100 KM
SELECT ST_AsEncodedPolyline(
ST_Segmentize(
ST_GeogFromText('LINESTRING(-71.0519 42.4935,-122.4483 37.64)'),
100000)::geometry) As encodedFlightPath;</programlisting>
<para>javascript will look something like this where $ variable you replace with query result</para>
<programlisting><![CDATA[
<script type="text/javascript" src="http://maps.googleapis.com/maps/api/js?libraries=geometry"></script>
<script type="text/javascript">
flightPath = new google.maps.Polyline({
path: google.maps.geometry.encoding.decodePath("$encodedFlightPath"),
map: map,
strokeColor: '#0000CC',
strokeOpacity: 1.0,
strokeWeight: 4
});
</script>
]]></programlisting>
</refsection>
<!-- Optionally add a "See Also" section -->
<refsection>
<title>See Also</title>
<para><xref linkend="ST_LineFromEncodedPolyline"/>, <xref linkend="ST_Segmentize"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_AsFlatGeobuf">
<refnamediv>
<refname>ST_AsFlatGeobuf</refname>
<refpurpose>Return a FlatGeobuf representation of a set of rows.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>bytea <function>ST_AsFlatGeobuf</function></funcdef>
<paramdef><type>anyelement set </type> <parameter>row</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>bytea <function>ST_AsFlatGeobuf</function></funcdef>
<paramdef><type>anyelement </type> <parameter>row</parameter></paramdef>
<paramdef><type>bool </type> <parameter>index</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>bytea <function>ST_AsFlatGeobuf</function></funcdef>
<paramdef><type>anyelement </type> <parameter>row</parameter></paramdef>
<paramdef><type>bool </type> <parameter>index</parameter></paramdef>
<paramdef><type>text </type> <parameter>geom_name</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>
Return a FlatGeobuf representation (<link xlink:href="http://flatgeobuf.org">http://flatgeobuf.org</link>)
of a set of rows corresponding to a FeatureCollection.
NOTE: PostgreSQL bytea cannot exceed 1GB.
</para>
<para><varname>row</varname> row data with at least a geometry column.</para>
<para><varname>index</varname> toggle spatial index creation. Default is false.</para>
<para><varname>geom_name</varname> is the name of the geometry column in the row data. If NULL it will default to the first found geometry column.</para>
<para role="availability" conformance="3.2.0">Availability: 3.2.0</para>
</refsection>
</refentry>
<refentry xml:id="ST_AsGeobuf">
<refnamediv>
<refname>ST_AsGeobuf</refname>
<refpurpose>Return a Geobuf representation of a set of rows.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>bytea <function>ST_AsGeobuf</function></funcdef>
<paramdef><type>anyelement set </type> <parameter>row</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>bytea <function>ST_AsGeobuf</function></funcdef>
<paramdef><type>anyelement </type> <parameter>row</parameter></paramdef>
<paramdef><type>text </type> <parameter>geom_name</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>
Return a Geobuf representation (<link xlink:href="https://github.com/mapbox/geobuf">https://github.com/mapbox/geobuf</link>) of a set of rows corresponding to a FeatureCollection.
Every input geometry is analyzed to determine maximum precision for optimal storage.
Note that Geobuf in its current form cannot be streamed so the full output will be assembled in memory.
</para>
<para><varname>row</varname> row data with at least a geometry column.</para>
<para><varname>geom_name</varname> is the name of the geometry column in the row data. If NULL it will default to the first found geometry column.</para>
<para role="availability" conformance="2.4.0">Availability: 2.4.0</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>SELECT encode(ST_AsGeobuf(q, 'geom'), 'base64')
FROM (SELECT ST_GeomFromText('POLYGON((0 0,0 1,1 1,1 0,0 0))') AS geom) AS q;
st_asgeobuf
----------------------------------
GAAiEAoOCgwIBBoIAAAAAgIAAAE=
</programlisting>
</refsection>
</refentry>
<refentry xml:id="ST_AsGeoJSON">
<refnamediv>
<refname>ST_AsGeoJSON</refname>
<refpurpose>Return a geometry or feature in GeoJSON format.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>text <function>ST_AsGeoJSON</function></funcdef>
<paramdef><type>record </type> <parameter>feature</parameter></paramdef>
<paramdef choice="opt"><type>text </type> <parameter>geom_column=""</parameter></paramdef>
<paramdef choice="opt"><type>integer </type> <parameter>maxdecimaldigits=9</parameter></paramdef>
<paramdef choice="opt"><type>boolean </type> <parameter>pretty_bool=false</parameter></paramdef>
<paramdef choice="opt"><type>text </type> <parameter>id_column=''</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>text <function>ST_AsGeoJSON</function></funcdef>
<paramdef><type>geometry </type> <parameter>geom</parameter></paramdef>
<paramdef choice="opt"><type>integer </type> <parameter>maxdecimaldigits=9</parameter></paramdef>
<paramdef choice="opt"><type>integer </type> <parameter>options=8</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>text <function>ST_AsGeoJSON</function></funcdef>
<paramdef><type>geography </type> <parameter>geog</parameter></paramdef>
<paramdef choice="opt"><type>integer </type> <parameter>maxdecimaldigits=9</parameter></paramdef>
<paramdef choice="opt"><type>integer </type> <parameter>options=0</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>
Returns a geometry as a GeoJSON "geometry" object,
or a row as a GeoJSON "feature" object.
</para>
<para>
The resulting GeoJSON geometry and feature representations conform
with the <link xlink:href="https://tools.ietf.org/html/rfc7946">GeoJSON
specifications RFC 7946</link>, except when the parsed geometries
are referenced with a CRS other than WGS84 longitude and latitude
(<link xlink:href="https://epsg.io/4326">EPSG:4326</link>, <link
xlink:href="http://epsg.io/4326.gml">urn:ogc:def:crs:OGC::CRS84</link>);
the GeoJSON geometry object will then have a short CRS SRID identifier
attached by default.
2D and 3D Geometries are both supported.
GeoJSON only supports SFS 1.1 geometry types
(no curve support for example).
</para>
<para>
The <varname>geom_column</varname> parameter is used to distinguish
between multiple geometry columns.
If omitted, the first geometry column in the record will be determined.
Conversely, passing the parameter will save column type lookups.
</para>
<para>The <varname>maxdecimaldigits</varname> argument may be used to reduce the maximum number of decimal places used in output (defaults to 9). If you are using EPSG:4326 and are outputting the geometry only for display, <varname>maxdecimaldigits</varname>=6 can be a good choice for many maps.</para>
<warning>
<para>Using the <parameter>maxdecimaldigits</parameter> parameter
can cause output geometry to become invalid.
To avoid this use <xref linkend="ST_ReducePrecision"/>
with a suitable gridsize first.
</para>
</warning>
<para>The <varname>options</varname> argument can be used to add BBOX or CRS in GeoJSON output:
<itemizedlist>
<listitem>
<para>0: means no option</para>
</listitem>
<listitem>
<para>1: GeoJSON BBOX</para>
</listitem>
<listitem>
<para>2: GeoJSON Short CRS (e.g EPSG:4326)</para>
</listitem>
<listitem>
<para>4: GeoJSON Long CRS (e.g urn:ogc:def:crs:EPSG::4326)</para>
</listitem>
<listitem>
<para>8: GeoJSON Short CRS if not EPSG:4326 (default)</para>
</listitem>
</itemizedlist>
</para>
<para>The <varname>id_column</varname> parameter is used to set the "id" member of the returned GeoJSON features. As per GeoJSON RFC, this SHOULD be used whenever a feature has a commonly used identifier, such as a primary key. When not specified, the produced features will not get an "id" member and any columns other than the geometry, including any potential keys, will just end up inside the feature’s "properties" member.</para>
<para>The GeoJSON specification states that polygons are oriented using the Right-Hand Rule,
and some clients require this orientation.
This can be ensured by using <xref linkend="ST_ForcePolygonCCW"/>.
The specification also requires that geometry be in the WGS84 coordinate system
(SRID = 4326).
If necessary geometry can be projected into WGS84 using <xref linkend="ST_Transform"/>:
<code>ST_Transform( geom, 4326 )</code>.
</para>
<para>GeoJSON can be tested and viewed online at <link xlink:href="http://geojson.io/">geojson.io</link>
and <link xlink:href="http://geojson.io/">geojsonlint.com</link>.
It is widely supported by web mapping frameworks:
<itemizedlist>
<listitem><para><link xlink:href="https://openlayers.org/en/latest/examples/geojson.html">OpenLayers GeoJSON Example</link></para></listitem>
<listitem><para><link xlink:href="https://leafletjs.com/examples/geojson/">Leaflet GeoJSON Example</link></para></listitem>
<listitem><para><link xlink:href="https://www.mapbox.com/mapbox-gl-js/example/multiple-geometries/">Mapbox GL GeoJSON Example</link></para></listitem>
</itemizedlist>
</para>
<para role="availability" conformance="1.3.4">Availability: 1.3.4</para>
<para role="availability" conformance="1.5.0">Availability: 1.5.0 geography support was introduced.</para>
<para role="changed" conformance="2.0.0">Changed: 2.0.0 support default args and named args.</para>
<para role="changed" conformance="3.0.0">Changed: 3.0.0 support records as input</para>
<para role="changed" conformance="3.0.0">Changed: 3.0.0 output SRID if not EPSG:4326.</para>
<para role="changed" conformance="3.5.0">Changed: 3.5.0 allow specifying the column containing the feature id</para>
<para>&Z_support;</para>
</refsection>
<refsection>
<title>Examples</title>
<para>Generate a FeatureCollection:</para>
<programlisting>SELECT json_build_object(
'type', 'FeatureCollection',
'features', json_agg(ST_AsGeoJSON(t.*, id_column => 'id')::json)
)
FROM ( VALUES (1, 'one', 'POINT(1 1)'::geometry),
(2, 'two', 'POINT(2 2)'),
(3, 'three', 'POINT(3 3)')
) as t(id, name, geom);</programlisting>
<screen>{"type" : "FeatureCollection", "features" : [{"type": "Feature", "geometry": {"type":"Point","coordinates":[1,1]}, "id": 1, "properties": {"name": "one"}}, {"type": "Feature", "geometry": {"type":"Point","coordinates":[2,2]}, "id": 2, "properties": {"name": "two"}}, {"type": "Feature", "geometry": {"type":"Point","coordinates":[3,3]}, "id": 3, "properties": {"name": "three"}}]}</screen>
<para>Generate a Feature:</para>
<programlisting>SELECT ST_AsGeoJSON(t.*, id_column => 'id')
FROM (VALUES (1, 'one', 'POINT(1 1)'::geometry)) AS t(id, name, geom);</programlisting>
<screen> st_asgeojson
-----------------------------------------------------------------------------------------------------------------
{"type": "Feature", "geometry": {"type":"Point","coordinates":[1,1]}, "id": 1, "properties": {"name": "one"}}
</screen>
<para>Don't forget to transform your data to WGS84 longitude, latitude to conform with the GeoJSON specification:</para>
<programlisting>SELECT ST_AsGeoJSON(ST_Transform(geom,4326)) from fe_edges limit 1;</programlisting>
<screen> st_asgeojson
-----------------------------------------------------------------------------------------------------------
{"type":"MultiLineString","coordinates":[[[-89.734634999999997,31.492072000000000],
[-89.734955999999997,31.492237999999997]]]}
</screen>
<para>3D geometries are supported:</para>
<programlisting>SELECT ST_AsGeoJSON('LINESTRING(1 2 3, 4 5 6)');</programlisting>
<screen>{"type":"LineString","coordinates":[[1,2,3],[4,5,6]]}</screen>
<para>Options argument can be used to add BBOX and CRS in GeoJSON output:</para>
<programlisting> SELECT ST_AsGeoJSON(ST_SetSRID('POINT(1 1)'::geometry, 4326), 9, 4|1);</programlisting>
<screen>
{"type":"Point","crs":{"type":"name","properties":{"name":"urn:ogc:def:crs:EPSG::4326"}},"bbox":[1.000000000,1.000000000,1.000000000,1.000000000],"coordinates":[1,1]}
</screen>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_GeomFromGeoJSON"/>, <xref linkend="ST_ForcePolygonCCW"/>, <xref linkend="ST_Transform"/> </para>
</refsection>
</refentry>
<refentry xml:id="ST_AsGML">
<refnamediv>
<refname>ST_AsGML</refname>
<refpurpose>Return the geometry as a GML version 2 or 3 element.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>text <function>ST_AsGML</function></funcdef>
<paramdef><type>geometry </type> <parameter>geom</parameter></paramdef>
<paramdef choice="opt"><type>integer </type> <parameter>maxdecimaldigits=15</parameter></paramdef>
<paramdef choice="opt"><type>integer </type> <parameter>options=0</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>text <function>ST_AsGML</function></funcdef>
<paramdef><type>geography </type> <parameter>geog</parameter></paramdef>
<paramdef choice="opt"><type>integer </type> <parameter>maxdecimaldigits=15</parameter></paramdef>
<paramdef choice="opt"><type>integer </type> <parameter>options=0</parameter></paramdef>
<paramdef choice="opt"><type>text </type> <parameter>nprefix=null</parameter></paramdef>
<paramdef choice="opt"><type>text </type> <parameter>id=null</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>text <function>ST_AsGML</function></funcdef>
<paramdef><type>integer </type> <parameter>version</parameter></paramdef>
<paramdef><type>geometry </type> <parameter>geom</parameter></paramdef>
<paramdef choice="opt"><type>integer </type> <parameter>maxdecimaldigits=15</parameter></paramdef>
<paramdef choice="opt"><type>integer </type> <parameter>options=0</parameter></paramdef>
<paramdef choice="opt"><type>text </type> <parameter>nprefix=null</parameter></paramdef>
<paramdef choice="opt"><type>text </type> <parameter>id=null</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>text <function>ST_AsGML</function></funcdef>
<paramdef><type>integer </type> <parameter>version</parameter></paramdef>
<paramdef><type>geography </type> <parameter>geog</parameter></paramdef>
<paramdef choice="opt"><type>integer </type> <parameter>maxdecimaldigits=15</parameter></paramdef>
<paramdef choice="opt"><type>integer </type> <parameter>options=0</parameter></paramdef>
<paramdef choice="opt"><type>text </type> <parameter>nprefix=null</parameter></paramdef>
<paramdef choice="opt"><type>text </type> <parameter>id=null</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Return the geometry as a Geography Markup Language (GML) element. The version parameter,
if specified, may be either 2 or 3. If no version parameter is
specified then the default is assumed to be 2. The <varname>maxdecimaldigits</varname> argument
may be used to reduce the maximum number of decimal places
used in output (defaults to 15).</para>
<warning>
<para>Using the <parameter>maxdecimaldigits</parameter> parameter
can cause output geometry to become invalid.
To avoid this use <xref linkend="ST_ReducePrecision"/>
with a suitable gridsize first.
</para>
</warning>
<para>GML 2 refer to 2.1.2 version, GML 3 to 3.1.1 version</para>
<para>The 'options' argument is a bitfield. It could be used to define CRS output type
in GML output, and to declare data as lat/lon:
<itemizedlist>
<listitem>
<para>0: GML Short CRS (e.g EPSG:4326), default value</para>
</listitem>
<listitem>
<para>1: GML Long CRS (e.g urn:ogc:def:crs:EPSG::4326)</para>
</listitem>
<listitem>
<para>2: For GML 3 only, remove srsDimension attribute from output.</para>
</listitem>
<listitem>
<para>4: For GML 3 only, use <LineString> rather than <Curve> tag for lines.</para>
</listitem>
<listitem>
<para>16: Declare that data are lat/lon (e.g srid=4326). Default is to assume that data are planars.
This option is useful for GML 3.1.1 output only, related to axis order. So if you set it, it will swap the coordinates
so order is lat lon instead of database lon lat.</para>
</listitem>
<listitem>
<para>32: Output the box of the geometry (envelope).</para>
</listitem>
</itemizedlist>
</para>
<para>The 'namespace prefix' argument may be used to specify a custom
namespace prefix or no prefix (if empty). If null or omitted 'gml' prefix is used</para>
<para role="availability" conformance="1.3.2">Availability: 1.3.2</para>
<para role="availability" conformance="1.5.0">Availability: 1.5.0 geography support was introduced.</para>
<para role="enhanced" conformance="2.0.0">Enhanced: 2.0.0 prefix support was introduced. Option 4 for GML3 was introduced to allow using LineString instead of Curve tag for lines. GML3 Support for Polyhedral surfaces and TINS was introduced. Option 32 was introduced to output the box.</para>
<para role="changed" conformance="2.0.0">Changed: 2.0.0 use default named args</para>
<para role="enhanced" conformance="2.1.0">Enhanced: 2.1.0 id support was introduced, for GML 3.</para>
<note><para>Only version 3+ of ST_AsGML supports Polyhedral Surfaces and TINS.</para></note>
<para>&sqlmm_compliant; SQL-MM IEC 13249-3: 17.2</para>
<para>&Z_support;</para>
<para>&P_support;</para>
<para>&T_support;</para>
</refsection>
<refsection>
<title>Examples: Version 2</title>
<programlisting><![CDATA[
SELECT ST_AsGML(ST_GeomFromText('POLYGON((0 0,0 1,1 1,1 0,0 0))',4326));
st_asgml
--------
<gml:Polygon srsName="EPSG:4326"><gml:outerBoundaryIs><gml:LinearRing><gml:coordinates>0,0 0,1 1,1 1,0 0,0</gml:coordinates></gml:LinearRing></gml:outerBoundaryIs></gml:Polygon>
]]></programlisting>
</refsection>
<refsection>
<title>Examples: Version 3</title>
<programlisting><![CDATA[
-- Flip coordinates and output extended EPSG (16 | 1)--
SELECT ST_AsGML(3, ST_GeomFromText('POINT(5.234234233242 6.34534534534)',4326), 5, 17);
st_asgml
--------
<gml:Point srsName="urn:ogc:def:crs:EPSG::4326"><gml:pos>6.34535 5.23423</gml:pos></gml:Point>
]]></programlisting>
<programlisting><![CDATA[
-- Output the envelope (32) --
SELECT ST_AsGML(3, ST_GeomFromText('LINESTRING(1 2, 3 4, 10 20)',4326), 5, 32);
st_asgml
--------
<gml:Envelope srsName="EPSG:4326">
<gml:lowerCorner>1 2</gml:lowerCorner>
<gml:upperCorner>10 20</gml:upperCorner>
</gml:Envelope>
]]></programlisting>
<programlisting><![CDATA[
-- Output the envelope (32) , reverse (lat lon instead of lon lat) (16), long srs (1)= 32 | 16 | 1 = 49 --
SELECT ST_AsGML(3, ST_GeomFromText('LINESTRING(1 2, 3 4, 10 20)',4326), 5, 49);
st_asgml
--------
<gml:Envelope srsName="urn:ogc:def:crs:EPSG::4326">
<gml:lowerCorner>2 1</gml:lowerCorner>
<gml:upperCorner>20 10</gml:upperCorner>
</gml:Envelope>
]]></programlisting>
<programlisting><![CDATA[
-- Polyhedral Example --
SELECT ST_AsGML(3, 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_asgml
--------
<gml:PolyhedralSurface>
<gml:polygonPatches>
<gml:PolygonPatch>
<gml:exterior>
<gml:LinearRing>
<gml:posList srsDimension="3">0 0 0 0 0 1 0 1 1 0 1 0 0 0 0</gml:posList>
</gml:LinearRing>
</gml:exterior>
</gml:PolygonPatch>
<gml:PolygonPatch>
<gml:exterior>
<gml:LinearRing>
<gml:posList srsDimension="3">0 0 0 0 1 0 1 1 0 1 0 0 0 0 0</gml:posList>
</gml:LinearRing>
</gml:exterior>
</gml:PolygonPatch>
<gml:PolygonPatch>
<gml:exterior>
<gml:LinearRing>
<gml:posList srsDimension="3">0 0 0 1 0 0 1 0 1 0 0 1 0 0 0</gml:posList>
</gml:LinearRing>
</gml:exterior>
</gml:PolygonPatch>
<gml:PolygonPatch>
<gml:exterior>
<gml:LinearRing>
<gml:posList srsDimension="3">1 1 0 1 1 1 1 0 1 1 0 0 1 1 0</gml:posList>
</gml:LinearRing>
</gml:exterior>
</gml:PolygonPatch>
<gml:PolygonPatch>
<gml:exterior>
<gml:LinearRing>
<gml:posList srsDimension="3">0 1 0 0 1 1 1 1 1 1 1 0 0 1 0</gml:posList>
</gml:LinearRing>
</gml:exterior>
</gml:PolygonPatch>
<gml:PolygonPatch>
<gml:exterior>
<gml:LinearRing>
<gml:posList srsDimension="3">0 0 1 1 0 1 1 1 1 0 1 1 0 0 1</gml:posList>
</gml:LinearRing>
</gml:exterior>
</gml:PolygonPatch>
</gml:polygonPatches>
</gml:PolyhedralSurface>
]]></programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_GeomFromGML"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_AsKML">
<refnamediv>
<refname>ST_AsKML</refname>
<refpurpose>Return the geometry as a KML element.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>text <function>ST_AsKML</function></funcdef>
<paramdef><type>geometry </type> <parameter>geom</parameter></paramdef>
<paramdef choice="opt"><type>integer </type> <parameter>maxdecimaldigits=15</parameter></paramdef>
<paramdef choice="opt"><type>text </type> <parameter>nprefix=NULL</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>text <function>ST_AsKML</function></funcdef>
<paramdef><type>geography </type> <parameter>geog</parameter></paramdef>
<paramdef choice="opt"><type>integer </type> <parameter>maxdecimaldigits=15</parameter></paramdef>
<paramdef choice="opt"><type>text </type> <parameter>nprefix=NULL</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Return the geometry as a Keyhole Markup Language (KML) element.
default maximum number of decimal places is 15,
default namespace is no prefix.</para>
<warning>
<para>Using the <parameter>maxdecimaldigits</parameter> parameter
can cause output geometry to become invalid.
To avoid this use <xref linkend="ST_ReducePrecision"/>
with a suitable gridsize first.
</para>
</warning>
<note>
<para>Requires PostGIS be compiled with Proj support. Use <xref linkend="PostGIS_Full_Version"/> to confirm you have proj support compiled in.</para>
</note>
<note>
<para role="availability" conformance="1.2.2">Availability: 1.2.2 - later variants that include version param came in 1.3.2</para>
</note>
<note>
<para role="enhanced" conformance="2.0.0">Enhanced: 2.0.0 - Add prefix namespace, use default and named args</para>
</note>
<note>
<para role="changed" conformance="3.0.0">Changed: 3.0.0 - Removed the "versioned" variant signature</para>
</note>
<note>
<para>AsKML output will not work with geometries that do not have an SRID</para>
</note>
<para>&Z_support;</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting><![CDATA[
SELECT ST_AsKML(ST_GeomFromText('POLYGON((0 0,0 1,1 1,1 0,0 0))',4326));
st_askml
--------
<Polygon><outerBoundaryIs><LinearRing><coordinates>0,0 0,1 1,1 1,0 0,0</coordinates></LinearRing></outerBoundaryIs></Polygon>
--3d linestring
SELECT ST_AsKML('SRID=4326;LINESTRING(1 2 3, 4 5 6)');
<LineString><coordinates>1,2,3 4,5,6</coordinates></LineString>
]]></programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_AsSVG"/>, <xref linkend="ST_AsGML"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_AsLatLonText">
<refnamediv>
<refname>ST_AsLatLonText</refname>
<refpurpose>Return the Degrees, Minutes, Seconds representation of the given point.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>text <function>ST_AsLatLonText</function></funcdef>
<paramdef><type>geometry </type> <parameter>pt</parameter></paramdef>
<paramdef><type>text </type> <parameter>format=''</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Returns the Degrees, Minutes, Seconds representation of the point.</para>
<note>
<para>It is assumed the point is in a lat/lon projection. The X (lon) and Y (lat) coordinates are normalized in the output
to the "normal" range (-180 to +180 for lon, -90 to +90 for lat).</para>
</note>
<para>
The text parameter is a format string containing the format for the resulting text, similar to a date format string. Valid tokens
are "D" for degrees, "M" for minutes, "S" for seconds, and "C" for cardinal direction (NSEW). DMS tokens may be repeated to indicate
desired width and precision ("SSS.SSSS" means " 1.0023").
</para>
<para>
"M", "S", and "C" are optional. If "C" is omitted, degrees are
shown with a "-" sign if south or west. If "S" is omitted, minutes will be shown as decimal with as many digits of precision
as you specify. If "M" is also omitted, degrees are shown as decimal with as many digits precision as you specify.
</para>
<para>
If the format string is omitted (or zero-length) a default format will be used.
</para>
<para role="availability" conformance="2.0">Availability: 2.0</para>
</refsection>
<refsection>
<title>Examples</title>
<para>Default format.</para>
<programlisting>
SELECT (ST_AsLatLonText('POINT (-3.2342342 -2.32498)'));
st_aslatlontext
----------------------------
2°19'29.928"S 3°14'3.243"W
</programlisting>
<para>Providing a format (same as the default).</para>
<programlisting>
SELECT (ST_AsLatLonText('POINT (-3.2342342 -2.32498)', 'D°M''S.SSS"C'));
st_aslatlontext
----------------------------
2°19'29.928"S 3°14'3.243"W
</programlisting>
<para>Characters other than D, M, S, C and . are just passed through.</para>
<programlisting>
SELECT (ST_AsLatLonText('POINT (-3.2342342 -2.32498)', 'D degrees, M minutes, S seconds to the C'));
st_aslatlontext
--------------------------------------------------------------------------------------
2 degrees, 19 minutes, 30 seconds to the S 3 degrees, 14 minutes, 3 seconds to the W
</programlisting>
<para>Signed degrees instead of cardinal directions.</para>
<programlisting>
SELECT (ST_AsLatLonText('POINT (-3.2342342 -2.32498)', 'D°M''S.SSS"'));
st_aslatlontext
----------------------------
-2°19'29.928" -3°14'3.243"
</programlisting>
<para>Decimal degrees.</para>
<programlisting>
SELECT (ST_AsLatLonText('POINT (-3.2342342 -2.32498)', 'D.DDDD degrees C'));
st_aslatlontext
-----------------------------------
2.3250 degrees S 3.2342 degrees W
</programlisting>
<para>Excessively large values are normalized.</para>
<programlisting>
SELECT (ST_AsLatLonText('POINT (-302.2342342 -792.32498)'));
st_aslatlontext
-------------------------------
72°19'29.928"S 57°45'56.757"E
</programlisting>
</refsection>
<!-- Optionally add a "See Also" section -->
</refentry>
<refentry xml:id="ST_AsMARC21">
<refnamediv>
<refname>ST_AsMARC21</refname>
<refpurpose>Returns geometry as a MARC21/XML record with a geographic datafield (034).</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>
text
<function>ST_AsMARC21</function>
</funcdef>
<paramdef>
<type>geometry </type>
<parameter>geom</parameter>
</paramdef>
<paramdef choice="opt">
<type>text </type>
<parameter>format='hdddmmss'</parameter>
</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>This function returns a MARC21/XML record with <link xlink:href="https://www.loc.gov/marc/bibliographic/bd034.html">Coded Cartographic Mathematical Data</link> representing the bounding box of a given geometry.
The <varname>format</varname> parameter allows to encode the coordinates in subfields <varname>$d</varname>,<varname>$e</varname>,<varname>$f</varname> and <varname>$g</varname> in all formats supported by the MARC21/XML standard. Valid formats are:</para>
<itemizedlist>
<listitem><para>cardinal direction, degrees, minutes and seconds (default): <varname>hdddmmss</varname></para></listitem>
<listitem><para>decimal degrees with cardinal direction: <varname>hddd.dddddd</varname></para></listitem>
<listitem><para>decimal degrees without cardinal direction: <varname>ddd.dddddd</varname></para></listitem>
<listitem><para>decimal minutes with cardinal direction: <varname>hdddmm.mmmm</varname></para></listitem>
<listitem><para>decimal minutes without cardinal direction: <varname>dddmm.mmmm</varname></para></listitem>
<listitem><para>decimal seconds with cardinal direction: <varname>hdddmmss.sss</varname></para></listitem>
</itemizedlist>
<para>The decimal sign may be also a comma, e.g. <varname>hdddmm,mmmm</varname>.</para>
<para>The precision of decimal formats can be limited by the number of characters after the decimal sign, e.g. <varname>hdddmm.mm</varname> for decimal minutes with a precision of two decimals.</para>
<para>This function ignores the Z and M dimensions.</para>
<para>
LOC MARC21/XML versions supported:
<itemizedlist>
<listitem>
<para><link xlink:href="https://www.loc.gov/standards/marcxml/">MARC21/XML 1.1</link></para>
</listitem>
</itemizedlist>
</para>
<para role="availability" conformance="3.3.0">Availability: 3.3.0 </para>
<note>
<para>This function does not support non lon/lat geometries, as they are not supported by the MARC21/XML standard (Coded Cartographic Mathematical Data).</para>
</note>
<note>
<para>
The MARC21/XML Standard does not provide any means to annotate the spatial reference system for Coded Cartographic Mathematical Data, which means that this information will be lost after conversion to MARC21/XML.
</para>
</note>
</refsection>
<refsection>
<title>Examples</title>
<para>Converting a <varname>POINT</varname> to MARC21/XML formatted as hdddmmss (default)</para>
<programlisting><![CDATA[
SELECT ST_AsMARC21('SRID=4326;POINT(-4.504289 54.253312)'::geometry);
st_asmarc21
-------------------------------------------------
<record xmlns="http://www.loc.gov/MARC21/slim">
<datafield tag="034" ind1="1" ind2=" ">
<subfield code="a">a</subfield>
<subfield code="d">W0043015</subfield>
<subfield code="e">W0043015</subfield>
<subfield code="f">N0541512</subfield>
<subfield code="g">N0541512</subfield>
</datafield>
</record>
]]></programlisting>
<para>Converting a <varname>POLYGON</varname> to MARC21/XML formatted in decimal degrees</para>
<programlisting><![CDATA[
SELECT ST_AsMARC21('SRID=4326;POLYGON((-4.5792388916015625 54.18172660239091,-4.56756591796875 54.196993557130355,-4.546623229980469 54.18313300502024,-4.5792388916015625 54.18172660239091))'::geometry,'hddd.dddd');
<record xmlns="http://www.loc.gov/MARC21/slim">
<datafield tag="034" ind1="1" ind2=" ">
<subfield code="a">a</subfield>
<subfield code="d">W004.5792</subfield>
<subfield code="e">W004.5466</subfield>
<subfield code="f">N054.1970</subfield>
<subfield code="g">N054.1817</subfield>
</datafield>
</record>
]]></programlisting>
<para>Converting a <varname>GEOMETRYCOLLECTION</varname> to MARC21/XML formatted in decimal minutes. The geometries order in the MARC21/XML output correspond to their order in the collection.</para>
<programlisting><![CDATA[
SELECT ST_AsMARC21('SRID=4326;GEOMETRYCOLLECTION(POLYGON((13.1 52.65,13.516666666666667 52.65,13.516666666666667 52.38333333333333,13.1 52.38333333333333,13.1 52.65)),POINT(-4.5 54.25))'::geometry,'hdddmm.mmmm');
st_asmarc21
-------------------------------------------------
<record xmlns="http://www.loc.gov/MARC21/slim">
<datafield tag="034" ind1="1" ind2=" ">
<subfield code="a">a</subfield>
<subfield code="d">E01307.0000</subfield>
<subfield code="e">E01331.0000</subfield>
<subfield code="f">N05240.0000</subfield>
<subfield code="g">N05224.0000</subfield>
</datafield>
<datafield tag="034" ind1="1" ind2=" ">
<subfield code="a">a</subfield>
<subfield code="d">W00430.0000</subfield>
<subfield code="e">W00430.0000</subfield>
<subfield code="f">N05415.0000</subfield>
<subfield code="g">N05415.0000</subfield>
</datafield>
</record>
]]></programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_GeomFromMARC21"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_AsMVTGeom">
<refnamediv>
<refname>ST_AsMVTGeom</refname>
<refpurpose>Transforms a geometry into the coordinate space of a MVT tile.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_AsMVTGeom</function></funcdef>
<paramdef><type>geometry </type> <parameter>geom</parameter></paramdef>
<paramdef><type>box2d </type> <parameter>bounds</parameter></paramdef>
<paramdef choice="opt"><type>integer </type> <parameter>extent=4096</parameter></paramdef>
<paramdef choice="opt"><type>integer </type> <parameter>buffer=256</parameter></paramdef>
<paramdef choice="opt"><type>boolean </type> <parameter>clip_geom=true</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Transforms a geometry into the coordinate space of a MVT (<link xlink:href="https://www.mapbox.com/vector-tiles/">Mapbox Vector Tile</link>) tile,
clipping it to the tile bounds if required.
The geometry must be in the coordinate system of the target map (using <xref linkend="ST_Transform"/> if needed).
Commonly this is <link xlink:href="https://en.wikipedia.org/wiki/Web_Mercator_projection">Web Mercator</link> (SRID:3857).
</para>
<para>The function attempts to preserve geometry validity, and corrects it if needed.
This may cause the result geometry to collapse to a lower dimension.
</para>
<para>The rectangular bounds of the tile in the target map coordinate space must be provided,
so the geometry can be transformed, and clipped if required.
The bounds can be generated using <xref linkend="ST_TileEnvelope"/>.
</para>
<para>
This function is used to convert geometry into the tile coordinate space required by <xref linkend="ST_AsMVT"/>.
</para>
<para><varname>geom</varname> is the geometry to transform, in the coordinate system of the target map.</para>
<para><varname>bounds</varname> is the rectangular bounds of the tile in map coordinate space, with no buffer.</para>
<para><varname>extent</varname> is the tile extent size in tile coordinate space as defined by the <link xlink:href="https://www.mapbox.com/vector-tiles/specification/">MVT specification</link>. Defaults to 4096.</para>
<para><varname>buffer</varname> is the buffer size in tile coordinate space for geometry clippig. Defaults to 256.</para>
<para><varname>clip_geom</varname> is a boolean to control if geometries are clipped or encoded as-is. Defaults to true.</para>
<para role="availability" conformance="2.4.0">Availability: 2.4.0</para>
<note>
<para>From 3.0, Wagyu can be chosen at configure time to clip and validate MVT polygons. This library is faster and produces more correct results than the GEOS default, but it might drop small polygons.</para>
</note>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>
SELECT ST_AsText(ST_AsMVTGeom(
ST_GeomFromText('POLYGON ((0 0, 10 0, 10 5, 0 -5, 0 0))'),
ST_MakeBox2D(ST_Point(0, 0), ST_Point(4096, 4096)),
4096, 0, false));
st_astext
--------------------------------------------------------------------
MULTIPOLYGON(((5 4096,10 4091,10 4096,5 4096)),((5 4096,0 4101,0 4096,5 4096)))
</programlisting>
<para>Canonical example for a Web Mercator tile using a computed tile bounds to query and clip geometry. This assumes the data.geom column has srid of 4326.
</para>
<programlisting><![CDATA[
SELECT ST_AsMVTGeom(
ST_Transform( geom, 3857 ),
ST_TileEnvelope(12, 513, 412), extent => 4096, buffer => 64) AS geom
FROM data
WHERE geom && ST_Transform(ST_TileEnvelope(12, 513, 412, margin => (64.0 / 4096)),4326)
]]></programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para>
<xref linkend="ST_AsMVT"/>,
<xref linkend="ST_TileEnvelope"/>,
<xref linkend="PostGIS_Wagyu_Version"/>
</para>
</refsection>
</refentry>
<refentry xml:id="ST_AsMVT">
<refnamediv>
<refname>ST_AsMVT</refname>
<refpurpose>Aggregate function returning a MVT representation of a set of rows.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>bytea <function>ST_AsMVT</function></funcdef>
<paramdef><type>anyelement set </type> <parameter>row</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>bytea <function>ST_AsMVT</function></funcdef>
<paramdef><type>anyelement </type> <parameter>row</parameter></paramdef>
<paramdef><type>text </type> <parameter>name</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>bytea <function>ST_AsMVT</function></funcdef>
<paramdef><type>anyelement </type> <parameter>row</parameter></paramdef>
<paramdef><type>text </type> <parameter>name</parameter></paramdef>
<paramdef><type>integer </type> <parameter>extent</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>bytea <function>ST_AsMVT</function></funcdef>
<paramdef><type>anyelement </type> <parameter>row</parameter></paramdef>
<paramdef><type>text </type> <parameter>name</parameter></paramdef>
<paramdef><type>integer </type> <parameter>extent</parameter></paramdef>
<paramdef><type>text </type> <parameter>geom_name</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>bytea <function>ST_AsMVT</function></funcdef>
<paramdef><type>anyelement </type> <parameter>row</parameter></paramdef>
<paramdef><type>text </type> <parameter>name</parameter></paramdef>
<paramdef><type>integer </type> <parameter>extent</parameter></paramdef>
<paramdef><type>text </type> <parameter>geom_name</parameter></paramdef>
<paramdef><type>text </type> <parameter>feature_id_name</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>An aggregate function which returns a binary <link xlink:href="https://www.mapbox.com/vector-tiles/">Mapbox Vector Tile</link>
representation of a set of rows corresponding to a tile layer.
The rows must contain a geometry column which will be encoded as a feature geometry.
The geometry must be in tile coordinate space
and valid as per the <link xlink:href="https://www.mapbox.com/vector-tiles/specification/">MVT specification</link>.
<xref linkend="ST_AsMVTGeom"/> can be used to transform geometry into tile coordinate space.
Other row columns are encoded as feature attributes.
</para>
<para>The <link xlink:href="https://www.mapbox.com/vector-tiles/">Mapbox Vector Tile</link> format
can store features with varying sets of attributes.
To use this capability supply a JSONB column in the row data containing Json objects one level deep.
The keys and values in the JSONB values will be encoded as feature attributes.
</para>
<para>
Tiles with multiple layers can be created by concatenating multiple calls to this function
using <varname>||</varname> or <varname>STRING_AGG</varname>.
</para>
<important>
<para>Do not call with a <varname>GEOMETRYCOLLECTION</varname> as an element in the row.
However you can use <xref linkend="ST_AsMVTGeom"/> to prepare a geometry collection for inclusion.</para>
</important>
<para><varname>row</varname> row data with at least a geometry column.</para>
<para><varname>name</varname> is the name of the layer. Default is the string "default".</para>
<para><varname>extent</varname> is the tile extent in screen space as defined by the specification. Default is 4096.</para>
<para><varname>geom_name</varname> is the name of the geometry column in the row data. Default is the first geometry column. Note that PostgreSQL by default automatically <link xlink:href="https://www.postgresql.org/docs/current/sql-syntax-lexical.html#SQL-SYNTAX-IDENTIFIERS">folds unquoted identifiers to lower case</link>, which means that unless the geometry column is quoted, e.g. <varname>"MyMVTGeom"</varname>, this parameter must be provided as lowercase.</para>
<para><varname>feature_id_name</varname> is the name of the Feature ID column in the row data. If NULL or negative the Feature ID is not set. The first column matching name and valid type (smallint, integer, bigint) will be used as Feature ID, and any subsequent column will be added as a property. JSON properties are not supported.</para>
<para role="enhanced" conformance="3.0">Enhanced: 3.0 - added support for Feature ID.</para>
<para role="enhanced" conformance="2.5.0">Enhanced: 2.5.0 - added support parallel query.</para>
<para role="availability" conformance="2.4.0">Availability: 2.4.0</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting><![CDATA[
WITH mvtgeom AS
(
SELECT ST_AsMVTGeom(geom, ST_TileEnvelope(12, 513, 412), extent => 4096, buffer => 64) AS geom, name, description
FROM points_of_interest
WHERE geom && ST_TileEnvelope(12, 513, 412, margin => (64.0 / 4096))
)
SELECT ST_AsMVT(mvtgeom.*)
FROM mvtgeom;
]]>
</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para>
<xref linkend="ST_AsMVTGeom"/>, <xref linkend="ST_TileEnvelope"/>
</para>
</refsection>
</refentry>
<refentry xml:id="ST_AsSVG">
<refnamediv>
<refname>ST_AsSVG</refname>
<refpurpose>Returns SVG path data for a geometry.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>text <function>ST_AsSVG</function></funcdef>
<paramdef><type>geometry </type> <parameter>geom</parameter></paramdef>
<paramdef choice="opt"><type>integer </type> <parameter>rel=0</parameter></paramdef>
<paramdef choice="opt"><type>integer </type> <parameter>maxdecimaldigits=15</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>text <function>ST_AsSVG</function></funcdef>
<paramdef><type>geography </type> <parameter>geog</parameter></paramdef>
<paramdef choice="opt"><type>integer </type> <parameter>rel=0</parameter></paramdef>
<paramdef choice="opt"><type>integer </type> <parameter>maxdecimaldigits=15</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Return the geometry as Scalar Vector Graphics (SVG) path data. Use 1 as second
argument to have the path data implemented in terms of relative
moves, the default (or 0) uses absolute moves. Third argument may
be used to reduce the maximum number of decimal digits used in
output (defaults to 15). Point geometries will be rendered as
cx/cy when 'rel' arg is 0, x/y when 'rel' is 1. Multipoint
geometries are delimited by commas (","), GeometryCollection
geometries are delimited by semicolons (";").</para>
<para>For working with PostGIS SVG graphics, checkout <link xlink:href="https://github.com/dr-jts/pg_svg">pg_svg</link> library which
provides plpgsql functions for working with outputs from ST_AsSVG.</para>
<para role="enhanced" conformance="3.4.0">Enhanced: 3.4.0 to support all curve types</para>
<para role="changed" conformance="2.0.0">Changed: 2.0.0 to use default args and support named args</para>
<note>
<para role="availability" conformance="1.2.2.">Availability: 1.2.2. Availability: 1.4.0 Changed in PostGIS 1.4.0 to include L command in absolute path to conform to <link xlink:href="http://www.w3.org/TR/SVG/paths.html#PathDataBNF">http://www.w3.org/TR/SVG/paths.html#PathDataBNF</link></para>
</note>
<para>&curve_support;</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>SELECT ST_AsSVG('POLYGON((0 0,0 1,1 1,1 0,0 0))'::geometry);
st_assvg
--------
M 0 0 L 0 -1 1 -1 1 0 Z</programlisting>
<para>Circular string</para>
<programlisting>SELECT ST_AsSVG( ST_GeomFromText('CIRCULARSTRING(-2 0,0 2,2 0,0 2,2 4)') );
st_assvg
--------
M -2 0 A 2 2 0 0 1 2 0 A 2 2 0 0 1 2 -4</programlisting>
<para>Multi-curve</para>
<programlisting>SELECT ST_AsSVG('MULTICURVE((5 5,3 5,3 3,0 3),
CIRCULARSTRING(0 0,2 1,2 2))'::geometry, 0, 0);
st_assvg
------------------------------------------------
M 5 -5 L 3 -5 3 -3 0 -3 M 0 0 A 2 2 0 0 0 2 -2
</programlisting>
<para>Multi-surface</para>
<programlisting>SELECT ST_AsSVG('MULTISURFACE(
CURVEPOLYGON(CIRCULARSTRING(-2 0,-1 -1,0 0,1 -1,2 0,0 2,-2 0),
(-1 0,0 0.5,1 0,0 1,-1 0)),
((7 8,10 10,6 14,4 11,7 8)))'::geometry, 0, 2);
st_assvg
---------------------------------------------------------
M -2 0 A 1 1 0 0 0 0 0 A 1 1 0 0 0 2 0 A 2 2 0 0 0 -2 0 Z
M -1 0 L 0 -0.5 1 0 0 -1 -1 0 Z
M 7 -8 L 10 -10 6 -14 4 -11 Z
</programlisting>
</refsection>
</refentry>
<refentry xml:id="ST_AsTWKB">
<refnamediv>
<refname>ST_AsTWKB</refname>
<refpurpose>Returns the geometry as TWKB, aka "Tiny Well-Known Binary"</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>bytea <function>ST_AsTWKB</function></funcdef>
<paramdef><type>geometry </type> <parameter>geom</parameter></paramdef>
<paramdef><type>integer </type> <parameter>prec=0</parameter></paramdef>
<paramdef><type>integer </type> <parameter>prec_z=0</parameter></paramdef>
<paramdef><type>integer </type> <parameter>prec_m=0</parameter></paramdef>
<paramdef><type>boolean </type> <parameter>with_sizes=false</parameter></paramdef>
<paramdef><type>boolean </type> <parameter>with_boxes=false</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>bytea <function>ST_AsTWKB</function></funcdef>
<paramdef><type>geometry[] </type> <parameter>geom</parameter></paramdef>
<paramdef><type>bigint[] </type> <parameter>ids</parameter></paramdef>
<paramdef><type>integer </type> <parameter>prec=0</parameter></paramdef>
<paramdef><type>integer </type> <parameter>prec_z=0</parameter></paramdef>
<paramdef><type>integer </type> <parameter>prec_m=0</parameter></paramdef>
<paramdef><type>boolean </type> <parameter>with_sizes=false</parameter></paramdef>
<paramdef><type>boolean </type> <parameter>with_boxes=false</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Returns the geometry in TWKB (Tiny Well-Known Binary) format. TWKB is a <link xlink:href="https://github.com/TWKB/Specification/blob/master/twkb.md">compressed binary format</link> with a focus on minimizing the size of the output. </para>
<para>The decimal digits parameters control how much precision is stored in the output. By default, values are rounded to the nearest unit before encoding. If you want to transfer more precision, increase the number. For example, a value of 1 implies that the first digit to the right of the decimal point will be preserved.</para>
<para>The sizes and bounding boxes parameters control whether optional information about the encoded length of the object and the bounds of the object are included in the output. By default they are not. Do not turn them on unless your client software has a use for them, as they just use up space (and saving space is the point of TWKB).</para>
<para>The array-input form of the function is used to convert a collection of geometries and unique identifiers into a TWKB collection that preserves the identifiers. This is useful for clients that expect to unpack a collection and then access further information about the objects inside. You can create the arrays using the <link xlink:href="https://www.postgresql.org/docs/current/functions-aggregate.html">array_agg</link> function. The other parameters operate the same as for the simple form of the function.</para>
<note>
<para>The format specification is available online at <link xlink:href="https://github.com/TWKB/Specification">https://github.com/TWKB/Specification</link>, and code for building a JavaScript client can be found at <link xlink:href="https://github.com/TWKB/twkb.js">https://github.com/TWKB/twkb.js</link>.</para>
</note>
<para role="enhanced" conformance="2.4.0">Enhanced: 2.4.0 memory and speed improvements.</para>
<para role="availability" conformance="2.2.0">Availability: 2.2.0</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>
SELECT ST_AsTWKB('LINESTRING(1 1,5 5)'::geometry);
st_astwkb
--------------------------------------------
\x02000202020808
</programlisting>
<para>To create an aggregate TWKB object including identifiers aggregate the desired geometries and objects first, using "array_agg()", then call the appropriate TWKB function.
</para>
<programlisting>
SELECT ST_AsTWKB(array_agg(geom), array_agg(gid)) FROM mytable;
st_astwkb
--------------------------------------------
\x040402020400000202
</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_GeomFromTWKB"/>, <xref linkend="ST_AsBinary"/>, <xref linkend="ST_AsEWKB"/>, <xref linkend="ST_AsEWKT"/>, <xref linkend="ST_GeomFromText"/></para>
</refsection>
</refentry>
<refentry xml:id="ST_AsX3D">
<refnamediv>
<refname>ST_AsX3D</refname>
<refpurpose>Returns a Geometry in X3D xml node element format: ISO-IEC-19776-1.2-X3DEncodings-XML</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>text <function>ST_AsX3D</function></funcdef>
<paramdef><type>geometry </type> <parameter>g1</parameter></paramdef>
<paramdef choice="opt"><type>integer </type> <parameter>maxdecimaldigits=15</parameter></paramdef>
<paramdef choice="opt"><type>integer </type> <parameter>options=0</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Returns a geometry as an X3D xml formatted node element <link xlink:href="http://www.web3d.org/standards/number/19776-1">http://www.web3d.org/standards/number/19776-1</link>. If <varname>maxdecimaldigits</varname> (precision) is not specified then defaults to 15. </para>
<note>
<para>There are various options for translating PostGIS geometries to X3D since X3D geometry types don't map directly to PostGIS geometry types and some newer X3D types that might be better mappings we have avoided since most rendering tools don't currently support them.
These are the mappings we have settled on. Feel free to post a bug ticket if you have thoughts on the idea or ways we can allow people to denote their preferred mappings.</para>
<para>Below is how we currently map PostGIS 2D/3D types to X3D types</para>
</note>
<para>The 'options' argument is a bitfield. For PostGIS 2.2+, this is used to denote whether to represent coordinates with X3D GeoCoordinates Geospatial node and also whether to flip the x/y axis. By default, <code>ST_AsX3D</code> outputs in database form (long,lat or X,Y), but X3D default of lat/lon, y/x may be preferred.</para>
<itemizedlist>
<listitem>
<para>0: X/Y in database order (e.g. long/lat = X,Y is standard database order), default value, and non-spatial coordinates (just regular old Coordinate tag).</para>
</listitem>
<listitem>
<para>1: Flip X and Y. If used in conjunction with the GeoCoordinate option switch, then output will be default "latitude_first" and coordinates will be flipped as well.</para>
</listitem>
<listitem>
<para>2: Output coordinates in GeoSpatial GeoCoordinates. This option will throw an error if geometries are not in WGS 84 long lat (srid: 4326). This is currently the only GeoCoordinate type supported. <link xlink:href="http://www.web3d.org/documents/specifications/19775-1/V3.2/Part01/components/geodata.html#Specifyingaspatialreference">Refer to X3D specs specifying a spatial reference system.</link>. Default output will be <code>GeoCoordinate geoSystem='"GD" "WE" "longitude_first"'</code>. If
you prefer the X3D default of <code>GeoCoordinate geoSystem='"GD" "WE" "latitude_first"'</code> use <code>(2 + 1)</code> = <code>3</code> </para>
</listitem>
</itemizedlist>
<informaltable>
<tgroup cols="3">
<thead>
<row>
<entry>PostGIS Type</entry>
<entry>2D X3D Type</entry>
<entry>3D X3D Type</entry>
</row>
</thead>
<tbody>
<row>
<entry>LINESTRING</entry>
<entry>not yet implemented - will be PolyLine2D</entry>
<entry>LineSet</entry>
</row>
<row>
<entry>MULTILINESTRING</entry>
<entry>not yet implemented - will be PolyLine2D</entry>
<entry>IndexedLineSet</entry>
</row>
<row>
<entry>MULTIPOINT</entry>
<entry>Polypoint2D</entry>
<entry>PointSet</entry>
</row>
<row>
<entry>POINT</entry>
<entry>outputs the space delimited coordinates</entry>
<entry>outputs the space delimited coordinates</entry>
</row>
<row>
<entry>(MULTI) POLYGON, POLYHEDRALSURFACE</entry>
<entry>Invalid X3D markup</entry>
<entry>IndexedFaceSet (inner rings currently output as another faceset)</entry>
</row>
<row>
<entry>TIN</entry>
<entry>TriangleSet2D (Not Yet Implemented)</entry>
<entry>IndexedTriangleSet</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<note><para>2D geometry support not yet complete. Inner rings currently just drawn as separate polygons. We are working on these.</para></note>
<para>Lots of advancements happening in 3D space particularly with <link xlink:href="https://www.web3d.org/wiki/index.php/X3D_and_HTML5">X3D Integration with HTML5</link></para>
<para>There is also a nice open source X3D viewer you can use to view rendered geometries. Free Wrl <link xlink:href="http://freewrl.sourceforge.net/">http://freewrl.sourceforge.net/</link> binaries available for Mac, Linux, and Windows. Use the FreeWRL_Launcher packaged to view the geometries.</para>
<para>Also check out <link xlink:href="https://git.osgeo.org/gitea/robe/postgis_x3d_viewer">PostGIS minimalist X3D viewer</link> that utilizes this function and <link xlink:href="http://www.x3dom.org/">x3dDom html/js open source toolkit</link>.</para>
<para role="availability" conformance="2.0.0">Availability: 2.0.0: ISO-IEC-19776-1.2-X3DEncodings-XML</para>
<para role="enhanced" conformance="2.2.0">Enhanced: 2.2.0: Support for GeoCoordinates and axis (x/y, long/lat) flipping. Look at options for details.</para>
<!-- Optionally mention 3d support -->
<para>&Z_support;</para>
<!-- Optionally mention supports Polyhedral Surface -->
<para>&P_support;</para>
<!-- Optionally mention support for Triangles and TINS -->
<para>&T_support;</para>
</refsection>
<refsection>
<title>Example: Create a fully functional X3D document - This will generate a cube that is viewable in FreeWrl and other X3D viewers.</title>
<programlisting><![CDATA[
SELECT '<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE X3D PUBLIC "ISO//Web3D//DTD X3D 3.0//EN" "http://www.web3d.org/specifications/x3d-3.0.dtd">
<X3D>
<Scene>
<Transform>
<Shape>
<Appearance>
<Material emissiveColor=''0 0 1''/>
</Appearance> ' ||
ST_AsX3D( 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)) )')) ||
'</Shape>
</Transform>
</Scene>
</X3D>' As x3ddoc;
x3ddoc
--------
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE X3D PUBLIC "ISO//Web3D//DTD X3D 3.0//EN" "http://www.web3d.org/specifications/x3d-3.0.dtd">
<X3D>
<Scene>
<Transform>
<Shape>
<Appearance>
<Material emissiveColor='0 0 1'/>
</Appearance>
<IndexedFaceSet coordIndex='0 1 2 3 -1 4 5 6 7 -1 8 9 10 11 -1 12 13 14 15 -1 16 17 18 19 -1 20 21 22 23'>
<Coordinate point='0 0 0 0 0 1 0 1 1 0 1 0 0 0 0 0 1 0 1 1 0 1 0 0 0 0 0 1 0 0 1 0 1 0 0 1 1 1 0 1 1 1 1 0 1 1 0 0 0 1 0 0 1 1 1 1 1 1 1 0 0 0 1 1 0 1 1 1 1 0 1 1' />
</IndexedFaceSet>
</Shape>
</Transform>
</Scene>
</X3D>
]]></programlisting>
</refsection>
<refsection>
<title>PostGIS buildings</title>
<para>
Copy and paste the output of this query to
<link xlink:href="http://postgis.net/docs/support/viewers/x3d_viewer.htm">x3d scene viewer</link>
and click Show
</para>
<programlisting><![CDATA[
SELECT string_agg('<Shape>' || ST_AsX3D(ST_Extrude(geom, 0,0, i*0.5)) ||
'<Appearance>
<Material diffuseColor="' || (0.01*i)::text || ' 0.8 0.2" specularColor="' || (0.05*i)::text || ' 0 0.5"/>
</Appearance>
</Shape>', '')
FROM ST_Subdivide(ST_Letters('PostGIS'),20) WITH ORDINALITY AS f(geom,i);
]]></programlisting>
<informalfigure>
<mediaobject>
<imageobject>
<imagedata fileref="images/st_asx3d01.png"/>
</imageobject>
<caption><para>Buildings formed by subdividing PostGIS and extrusion</para></caption>
</mediaobject>
</informalfigure>
</refsection>
<refsection>
<title>Example: An Octagon elevated 3 Units and decimal precision of 6</title>
<programlisting><![CDATA[
SELECT ST_AsX3D(
ST_Translate(
ST_Force_3d(
ST_Buffer(ST_Point(10,10),5, 'quad_segs=2')), 0,0,
3)
,6) As x3dfrag;
x3dfrag
--------
<IndexedFaceSet coordIndex="0 1 2 3 4 5 6 7">
<Coordinate point="15 10 3 13.535534 6.464466 3 10 5 3 6.464466 6.464466 3 5 10 3 6.464466 13.535534 3 10 15 3 13.535534 13.535534 3 " />
</IndexedFaceSet>
]]></programlisting>
</refsection>
<refsection>
<title>Example: TIN</title>
<programlisting><![CDATA[
SELECT ST_AsX3D(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 x3dfrag;
x3dfrag
--------
<IndexedTriangleSet index='0 1 2 3 4 5'><Coordinate point='0 0 0 0 0 1 0 1 0 0 0 0 0 1 0 1 1 0'/></IndexedTriangleSet>
]]></programlisting>
</refsection>
<refsection>
<title>Example: Closed multilinestring (the boundary of a polygon with holes)</title>
<programlisting><![CDATA[
SELECT ST_AsX3D(
ST_GeomFromEWKT('MULTILINESTRING((20 0 10,16 -12 10,0 -16 10,-12 -12 10,-20 0 10,-12 16 10,0 24 10,16 16 10,20 0 10),
(12 0 10,8 8 10,0 12 10,-8 8 10,-8 0 10,-8 -4 10,0 -8 10,8 -4 10,12 0 10))')
) As x3dfrag;
x3dfrag
--------
<IndexedLineSet coordIndex='0 1 2 3 4 5 6 7 0 -1 8 9 10 11 12 13 14 15 8'>
<Coordinate point='20 0 10 16 -12 10 0 -16 10 -12 -12 10 -20 0 10 -12 16 10 0 24 10 16 16 10 12 0 10 8 8 10 0 12 10 -8 8 10 -8 0 10 -8 -4 10 0 -8 10 8 -4 10 ' />
</IndexedLineSet>
]]></programlisting>
</refsection>
</refentry>
<refentry xml:id="ST_GeoHash">
<refnamediv>
<refname>ST_GeoHash</refname>
<refpurpose>Return a GeoHash representation of the geometry.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>text <function>ST_GeoHash</function></funcdef>
<paramdef><type>geometry </type> <parameter>geom</parameter></paramdef>
<paramdef choice="opt"><type>integer </type> <parameter>maxchars=full_precision_of_point</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Computes a <link xlink:href="http://en.wikipedia.org/wiki/Geohash">GeoHash</link> representation of a geometry.
A GeoHash encodes a geographic Point into a text form that is sortable and searchable based on prefixing.
A shorter GeoHash is a less precise representation of a point.
It can be thought of as a box that contains the point.
</para>
<para>Non-point geometry values with non-zero extent can also be mapped to GeoHash codes.
The precision of the code depends on the geographic extent of the geometry.
</para>
<para>If <varname>maxchars</varname> is not specified, the returned GeoHash code is for the smallest cell containing the input geometry.
Points return a GeoHash with 20 characters of precision (about enough to hold the full double precision of the input).
Other geometric types may return a GeoHash with less precision, depending on the extent of the geometry.
Larger geometries are represented with less precision, smaller ones with more precision.
The box determined by the GeoHash code always contains the input feature.</para>
<para>If <varname>maxchars</varname> is specified the returned GeoHash code has at most that many characters.
It maps to a (possibly) lower precision representation of the input geometry.
For non-points, the starting point of the calculation is the center of the bounding box of the geometry.</para>
<para role="availability" conformance="1.4.0">Availability: 1.4.0</para>
<note>
<para>ST_GeoHash requires input geometry to be in geographic (lon/lat) coordinates.</para>
</note>
<para>&curve_support;</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting>SELECT ST_GeoHash( ST_Point(-126,48) );
st_geohash
----------------------
c0w3hf1s70w3hf1s70w3
SELECT ST_GeoHash( ST_Point(-126,48), 5);
st_geohash
------------
c0w3h
-- This line contains the point, so the GeoHash is a prefix of the point code
SELECT ST_GeoHash('LINESTRING(-126 48, -126.1 48.1)'::geometry);
st_geohash
------------
c0w3
</programlisting>
</refsection>
<refsection>
<title>See Also</title>
<para><xref linkend="ST_GeomFromGeoHash"/>, <xref linkend="ST_PointFromGeoHash"/>, <xref linkend="ST_Box2dFromGeoHash"/></para>
</refsection>
</refentry>
</section>
</section>
|