From: Paul Ramsey <pramsey@cleverelephant.ca>
Date: Wed, 13 May 2015 18:38:02 +0000 (+0000)
Subject: #3085, document ST_GeomFromTWKB
X-Git-Tag: 2.2.0rc1~509
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=174ea1391ce6ce2cf38318253cdb6fc239e447c0;p=postgis

#3085, document ST_GeomFromTWKB


git-svn-id: http://svn.osgeo.org/postgis/trunk@13498 b70326c6-7e19-0410-871a-916f4a2858ee
---

diff --git a/doc/reference_constructor.xml b/doc/reference_constructor.xml
index eaf5d15de..531448328 100644
--- a/doc/reference_constructor.xml
+++ b/doc/reference_constructor.xml
@@ -227,7 +227,7 @@ UPDATE sometable SET geog = ST_GeogFromText('SRID=4326;POINT(' || lon || ' ' ||
 		<funcsynopsis>
 		  <funcprototype>
 			<funcdef>geography <function>ST_GeogFromWKB</function></funcdef>
-			<paramdef><type>bytea </type> <parameter>geom</parameter></paramdef>
+			<paramdef><type>bytea </type> <parameter>wkb</parameter></paramdef>
 		  </funcprototype>
 		</funcsynopsis>
 	  </refsynopsisdiv>
@@ -268,6 +268,50 @@ ST_GeogFromWKB(E'\\001\\002\\000\\000\\000\\002\\000\\000\\000\\037\\205\\353Q\\
 	  </refsection>
 </refentry>
 
+	<refentry id="ST_GeomFromTWKB">
+	  <refnamediv>
+		<refname>ST_GeomFromTWKB</refname>
+		<refpurpose>Creates a geometry instance from a TWKB ("<ulink url="https://github.com/TWKB/Specification/blob/master/twkb.md">Tiny Well-Known Binary</ulink>") geometry
+		representation.</refpurpose>
+	  </refnamediv>
+
+	  <refsynopsisdiv>
+		<funcsynopsis>
+		  <funcprototype>
+			<funcdef>geometry <function>ST_GeomFromTWKB</function></funcdef>
+			<paramdef><type>bytea </type> <parameter>twkb</parameter></paramdef>
+		  </funcprototype>
+		</funcsynopsis>
+	  </refsynopsisdiv>
+
+	  <refsection>
+		<title>Description</title>
+
+		<para>The <varname>ST_GeomFromTWKB</varname> function, takes a a TWKB ("<ulink url="https://github.com/TWKB/Specification/blob/master/twkb.md">Tiny Well-Known Binary</ulink>") geometry representation (WKB) and creates an instance of the appropriate
+		geometry type.</para>
+
+	  </refsection>
+
+
+	  <refsection>
+		<title>Examples</title>
+
+		<programlisting>
+SELECT ST_AsText(ST_GeomFromTWKB(ST_AsTWKB('LINESTRING(126 34, 127 35)'::geometry)));
+
+         st_astext
+-----------------------------
+ LINESTRING(126 34, 127 35)
+(1 row)
+
+</programlisting>
+	  </refsection>
+	   <refsection>
+		<title>See Also</title>
+		<para><xref linkend="ST_AsTWKB" /></para>
+	  </refsection>
+    </refentry>
+
 
 	<refentry id="ST_GeomCollFromText">
 	  <refnamediv>