[postgis-tickets] r15248 - Incorrect parameter name for CreateTopology
Regina Obe
lr at pcorp.us
Sat Nov 26 07:00:39 PST 2016
Author: robe
Date: 2016-11-26 07:00:39 -0800 (Sat, 26 Nov 2016)
New Revision: 15248
Modified:
branches/2.2/doc/extras_topology.xml
Log:
Incorrect parameter name for CreateTopology
closes #3509 for 2.2.4
Modified: branches/2.2/doc/extras_topology.xml
===================================================================
--- branches/2.2/doc/extras_topology.xml 2016-11-26 14:59:52 UTC (rev 15247)
+++ branches/2.2/doc/extras_topology.xml 2016-11-26 15:00:39 UTC (rev 15248)
@@ -581,68 +581,68 @@
<refname>CreateTopology</refname>
<refpurpose>Creates a new topology schema and registers this new schema in the topology.topology table.</refpurpose>
</refnamediv>
-
+
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>integer <function>CreateTopology</function></funcdef>
<paramdef><type>varchar </type> <parameter>topology_schema_name</parameter></paramdef>
</funcprototype>
-
+
<funcprototype>
<funcdef>integer <function>CreateTopology</function></funcdef>
<paramdef><type>varchar </type> <parameter>topology_schema_name</parameter></paramdef>
<paramdef><type>integer </type> <parameter>srid</parameter></paramdef>
</funcprototype>
-
+
<funcprototype>
<funcdef>integer <function>CreateTopology</function></funcdef>
<paramdef><type>varchar </type> <parameter>topology_schema_name</parameter></paramdef>
<paramdef><type>integer </type> <parameter>srid</parameter></paramdef>
- <paramdef><type>double precision </type> <parameter>tolerance</parameter></paramdef>
+ <paramdef><type>double precision </type> <parameter>prec</parameter></paramdef>
</funcprototype>
-
+
<funcprototype>
<funcdef>integer <function>CreateTopology</function></funcdef>
<paramdef><type>varchar </type> <parameter>topology_schema_name</parameter></paramdef>
<paramdef><type>integer </type> <parameter>srid</parameter></paramdef>
- <paramdef><type>double precision </type> <parameter>tolerance</parameter></paramdef>
+ <paramdef><type>double precision </type> <parameter>prec</parameter></paramdef>
<paramdef><type>boolean </type> <parameter>hasz</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
-
+
<refsection>
<title>Description</title>
-
+
<para>Creates a new schema with name <varname>topology_name</varname> consisting of tables (<varname>edge_data</varname>,<varname>face</varname>,<varname>node</varname>, <varname>relation</varname>
- and registers this new topology in the topology.topology table. It returns the id of the topology in the topology table. The srid is the spatial reference identified as
- defined in spatial_ref_sys table for that topology. Topologies must be uniquely named. The tolerance is measured in the units of the spatial reference system. If the tolerance is not specified defaults to 0.</para>
-
+ and registers this new topology in the topology.topology table. It returns the id of the topology in the topology table. The srid is the spatial reference identified as
+ defined in spatial_ref_sys table for that topology. Topologies must be uniquely named. The tolerance is measured in the units of the spatial reference system. If the tolerance (<varname>prec</varname>) is not specified defaults to 0.</para>
+
<para>This is similar to the SQL/MM <xref linkend="ST_InitTopoGeo" /> but a bit more functional. <varname>hasz</varname> defaults to false if not specified.</para>
-
+
<!-- use this format if new function -->
<para>Availability: 1.?</para>
</refsection>
-
-
+
+
<refsection>
<title>Examples</title>
<para>This example creates a new schema called ma_topo that will store edges, faces, and relations in Massachusetts State Plane meters.
The tolerance represents 1/2 meter since the spatial reference system is a meter based spatial reference system</para>
<programlisting>SELECT topology.CreateTopology('ma_topo',26986, 0.5);</programlisting>
-
+
<para>Create Rhode Island topology in State Plane ft</para>
<programlisting>SELECT topology.CreateTopology('ri_topo',3438) As topoid;
topoid
------
2</programlisting>
</refsection>
-
+
<!-- Optionally add a "See Also" section -->
<refsection>
<title>See Also</title>
-
+
<para><xref linkend="spatial_ref_sys"/>, <xref linkend="ST_InitTopoGeo" />, <xref linkend="Topology_Load_Tiger" /></para>
</refsection>
</refentry>
More information about the postgis-tickets
mailing list