Commit 4e431eb6 authored by Regina Obe's avatar Regina Obe

Add note that ST_Point and ST_MakePoint are faster for points as pointed out by God

parent 4d064baf
Pipeline #144962376 failed with stage
in 6 minutes and 1 second
......@@ -383,6 +383,43 @@ SELECT ST_GeomFromEWKT('POLYHEDRALSURFACE(
<para>&sfs_compliant; s3.2.6.2 - option SRID is from the conformance suite.</para>
<para>&sqlmm_compliant; SQL-MM 3: 5.1.40</para>
<para>&curve_support;</para>
<refentry id="ST_GeomFromText">
<refnamediv>
<refname>ST_GeomFromText</refname>
<refpurpose>Return a specified ST_Geometry value from Well-Known Text representation (WKT).</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>geometry <function>ST_GeomFromText</function></funcdef>
<paramdef><type>text </type> <parameter>WKT</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>geometry <function>ST_GeomFromText</function></funcdef>
<paramdef><type>text </type> <parameter>WKT</parameter></paramdef>
<paramdef><type>integer </type> <parameter>srid</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Constructs a PostGIS ST_Geometry object from the OGC Well-Known text representation.</para>
<!-- optionally mention that this function uses indexes if appropriate -->
<note>
<para>There are two variants of ST_GeomFromText function. The first takes no SRID and returns a geometry
with no defined spatial reference system (SRID=0). The second takes a SRID as the second argument
and returns a geometry that includes this SRID as part of its metadata.
</para>
</note>
<para>&sfs_compliant; s3.2.6.2 - option SRID is from the conformance suite.</para>
<para>&sqlmm_compliant; SQL-MM 3: 5.1.40</para>
<para>&curve_support;</para>
<note><para>While not OGC-compliant, <xref linkend="ST_MakePoint" /> is faster than ST_GeomFromText and ST_PointFromText. It is also easier to use for numeric coordinate values. <xref linkend="ST_Point" /> is another option similar in speed to <xref linkend="ST_Point" /> and is OGC-compliant, but doesn't support anything but 2D points.</para></note>
<warning><para>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. This should now be
written as ST_GeomFromText('GEOMETRYCOLLECTION EMPTY')</para></warning>
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment