]> granicus.if.org Git - postgis/commitdiff
document new ST_GeomFromGeoJSON function. Will provide examples later once resolved...
authorRegina Obe <lr@pcorp.us>
Fri, 18 Nov 2011 13:58:47 +0000 (13:58 +0000)
committerRegina Obe <lr@pcorp.us>
Fri, 18 Nov 2011 13:58:47 +0000 (13:58 +0000)
git-svn-id: http://svn.osgeo.org/postgis/trunk@8177 b70326c6-7e19-0410-871a-916f4a2858ee

doc/reference_constructor.xml

index 7fcb254749f73456b82c77b29a4a2f43827f7ba8..711ebd3d6dd43b286303e700d688f4de1ec4ead3 100644 (file)
@@ -581,6 +581,42 @@ SELECT ST_GeomFromEWKT('POLYHEDRALSURFACE(
          </refsection>
        </refentry>
        
+       <refentry id="ST_GeomFromGeoJSON">
+         <refnamediv>
+               <refname>ST_GeomFromGeoJSON</refname>
+               <refpurpose>Takes as input a geojson representation of a geometry and outputs a PostGIS geometry object</refpurpose>
+         </refnamediv>
+
+         <refsynopsisdiv>
+               <funcsynopsis>
+                 <funcprototype>
+                       <funcdef>geometry <function>ST_GeomFromGeoJSON</function></funcdef>
+                       <paramdef><type>text </type> <parameter>geomjson</parameter></paramdef>
+                 </funcprototype>
+               </funcsynopsis>
+         </refsynopsisdiv>
+
+         <refsection>
+               <title>Description</title>
+               <para>Constructs a PostGIS geometry object from the GeoJSON representation.</para>
+               <para>ST_GeomFromGeoJSON works only for JSON Geometry fragments. It throws an error if you try to use it on a whole JSON document.</para>
+               
+               <para>Availability: 2.0.0 requires - requires JSON-C &gt;= 0.9</para>
+         </refsection>
+        <refsection>
+               <title>Examples</title>
+               <!-- TODO -->
+               COMING SOON
+         </refsection>
+
+
+         <refsection>
+               <title>See Also</title>
+               <para><xref linkend="ST_AsGeoJSON" /></para>
+         </refsection>
+       </refentry>
+       
        <refentry id="ST_GeomFromKML">
          <refnamediv>
                <refname>ST_GeomFromKML</refname>