Author: paul
Date: 2008-01-26 01:32:49 +0100 (Sat, 26 Jan 2008)
New Revision: 9641
Log:
r28761@frost: paul | 2008-01-25 18:29:19 -0600
Finish marking up spatial functions.
Modified:
trunk/refman-4.1/spatial-extensions.xml
trunk/refman-5.0/spatial-extensions.xml
trunk/refman-5.1/spatial-extensions.xml
trunk/refman-6.0/spatial-extensions.xml
Property changes on: trunk
___________________________________________________________________
Name: svk:merge
- 4767c598-dc10-0410-bea0-d01b485662eb:/mysqldoc-local/mysqldoc/trunk:34985
7d8d2c4e-af1d-0410-ab9f-b038ce55645b:/mysqldoc-local/mysqldoc:28751
b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:14218
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:23408
+ 4767c598-dc10-0410-bea0-d01b485662eb:/mysqldoc-local/mysqldoc/trunk:34985
7d8d2c4e-af1d-0410-ab9f-b038ce55645b:/mysqldoc-local/mysqldoc:28761
b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:14218
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:23408
Modified: trunk/refman-4.1/spatial-extensions.xml
===================================================================
--- trunk/refman-4.1/spatial-extensions.xml 2008-01-26 00:31:52 UTC (rev 9640)
+++ trunk/refman-4.1/spatial-extensions.xml 2008-01-26 00:32:49 UTC (rev 9641)
Changed blocks: 89, Lines Added: 139, Lines Deleted: 137; 39651 bytes
@@ -1918,8 +1918,8 @@
<primary>LineStringFromText()</primary>
</indexterm>
- <literal>LineFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</literal>,
- <literal>LineStringFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</literal>
+ <function role="sql">LineFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</function>,
+ <function role="sql" condition="linefromtext">LineStringFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</function>
</para>
<para>
@@ -1948,8 +1948,8 @@
<primary>MultiLineStringFromText()</primary>
</indexterm>
- <literal>MLineFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</literal>,
- <literal>MultiLineStringFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</literal>
+ <function role="sql">MLineFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</function>,
+ <function role="sql" condition="mlinefromtext">MultiLineStringFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</function>
</para>
<para>
@@ -1978,8 +1978,8 @@
<primary>MultiPointFromText()</primary>
</indexterm>
- <literal>MPointFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</literal>,
- <literal>MultiPointFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</literal>
+ <function role="sql">MPointFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</function>,
+ <function role="sql" condition="mpointfromtext">MultiPointFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</function>
</para>
<para>
@@ -2008,8 +2008,8 @@
<primary>MultiPolygonFromText()</primary>
</indexterm>
- <literal>MPolyFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</literal>,
- <literal>MultiPolygonFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</literal>
+ <function role="sql">MPolyFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</function>,
+ <function role="sql" condition="mpolyfromtext">MultiPolygonFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</function>
</para>
<para>
@@ -2030,7 +2030,7 @@
<primary>PointFromText()</primary>
</indexterm>
- <literal>PointFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</literal>
+ <function role="sql">PointFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</function>
</para>
<para>
@@ -2059,8 +2059,8 @@
<primary>PolygonFromText()</primary>
</indexterm>
- <literal>PolyFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</literal>,
- <literal>PolygonFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</literal>
+ <function role="sql">PolyFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</function>,
+ <function role="sql" condition="polyfromtext">PolygonFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</function>
</para>
<para>
@@ -2091,7 +2091,7 @@
<primary>BdMPolyFromText()</primary>
</indexterm>
- <literal>BdMPolyFromText(<replaceable>wkt</replaceable>,<replaceable>srid</replaceable>)</literal>
+ <function role="sql">BdMPolyFromText(<replaceable>wkt</replaceable>,<replaceable>srid</replaceable>)</function>
</para>
<para>
@@ -2108,7 +2108,7 @@
<primary>BdPolyFromText()</primary>
</indexterm>
- <literal>BdPolyFromText(<replaceable>wkt</replaceable>,<replaceable>srid</replaceable>)</literal>
+ <function role="sql">BdPolyFromText(<replaceable>wkt</replaceable>,<replaceable>srid</replaceable>)</function>
</para>
<para>
@@ -2136,10 +2136,10 @@
</para>
<para>
- <literal>GeomFromWKB()</literal> accepts a WKB of any geometry
- type as its first argument. An implementation also provides
- type-specific construction functions for construction of
- geometry values of each geometry type.
+ <function role="sql">GeomFromWKB()</function> accepts a WKB of
+ any geometry type as its first argument. An implementation
+ also provides type-specific construction functions for
+ construction of geometry values of each geometry type.
</para>
<remark role="help-category" condition="WKB@Geographic Features"/>
@@ -2164,8 +2164,8 @@
<primary>GeometryCollectionFromWKB()</primary>
</indexterm>
- <literal>GeomCollFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</literal>,
- <literal>GeometryCollectionFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</literal>
+ <function role="sql">GeomCollFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</function>,
+ <function role="sql" condition="geomcollfromwkb">GeometryCollectionFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</function>
</para>
<para>
@@ -2194,8 +2194,8 @@
<primary>GeometryFromWKB()</primary>
</indexterm>
- <literal>GeomFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</literal>,
- <literal>GeometryFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</literal>
+ <function role="sql">GeomFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</function>,
+ <function role="sql" condition="geomfromwkb">GeometryFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</function>
</para>
<para>
@@ -2224,8 +2224,8 @@
<primary>LineStringFromWKB()</primary>
</indexterm>
- <literal>LineFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</literal>,
- <literal>LineStringFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</literal>
+ <function role="sql">LineFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</function>,
+ <function role="sql" condition="linefromwkb">LineStringFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</function>
</para>
<para>
@@ -2254,8 +2254,8 @@
<primary>MultiLineStringFromWKB()</primary>
</indexterm>
- <literal>MLineFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</literal>,
- <literal>MultiLineStringFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</literal>
+ <function role="sql">MLineFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</function>,
+ <function role="sql" condition="mlinefromwkb">MultiLineStringFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</function>
</para>
<para>
@@ -2284,8 +2284,8 @@
<primary>MultiPointFromWKB()</primary>
</indexterm>
- <literal>MPointFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</literal>,
- <literal>MultiPointFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</literal>
+ <function role="sql">MPointFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</function>,
+ <function role="sql" condition="mpointfromwkb">MultiPointFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</function>
</para>
<para>
@@ -2305,7 +2305,7 @@
<remark role="help-description-begin"/>
- <para id="function_mpolyfromwbk">
+ <para id="function_mpolyfromwkb">
<indexterm>
<primary>MPolyFromWKB()</primary>
</indexterm>
@@ -2314,8 +2314,8 @@
<primary>MultiPolygonFromWKB()</primary>
</indexterm>
- <literal>MPolyFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</literal>,
- <literal>MultiPolygonFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</literal>
+ <function role="sql">MPolyFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</function>,
+ <function role="sql" condition="mpolyfromwkb">MultiPolygonFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</function>
</para>
<para>
@@ -2340,7 +2340,7 @@
<primary>PointFromWKB()</primary>
</indexterm>
- <literal>PointFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</literal>
+ <function role="sql">PointFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</function>
</para>
<para>
@@ -2369,8 +2369,8 @@
<primary>PolygonFromWKB()</primary>
</indexterm>
- <literal>PolyFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</literal>,
- <literal>PolygonFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</literal>
+ <function role="sql">PolyFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</function>,
+ <function role="sql" condition="polyfromwkb">PolygonFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</function>
</para>
<para>
@@ -2400,7 +2400,7 @@
<primary>BdMPolyFromWKB()</primary>
</indexterm>
- <literal>BdMPolyFromWKB(<replaceable>wkb</replaceable>,<replaceable>srid</replaceable>)</literal>
+ <function role="sql">BdMPolyFromWKB(<replaceable>wkb</replaceable>,<replaceable>srid</replaceable>)</function>
</para>
<para>
@@ -2417,7 +2417,7 @@
<primary>BdPolyFromWKB()</primary>
</indexterm>
- <literal>BdPolyFromWKB(<replaceable>wkb</replaceable>,<replaceable>srid</replaceable>)</literal>
+ <function role="sql">BdPolyFromWKB(<replaceable>wkb</replaceable>,<replaceable>srid</replaceable>)</function>
</para>
<para>
@@ -2444,8 +2444,8 @@
<literal>BLOB</literal> values containing WKB representations
of geometry values with no SRID. The results of these
functions can be substituted as the first argument for any
- function in the <literal>GeomFromWKB()</literal> function
- family.
+ function in the <function role="sql">GeomFromWKB()</function>
+ function family.
</para>
<remark role="help-category" condition="Geometry constructors@Geographic Features"/>
@@ -2462,7 +2462,7 @@
<primary>GeometryCollection()</primary>
</indexterm>
- <literal>GeometryCollection(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>,...)</literal>
+ <function role="sql">GeometryCollection(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>,...)</function>
</para>
<para>
@@ -2484,7 +2484,7 @@
<primary>LineString()</primary>
</indexterm>
- <literal>LineString(<replaceable>pt1</replaceable>,<replaceable>pt2</replaceable>,...)</literal>
+ <function role="sql">LineString(<replaceable>pt1</replaceable>,<replaceable>pt2</replaceable>,...)</function>
</para>
<para>
@@ -2509,7 +2509,7 @@
<primary>MultiLineString()</primary>
</indexterm>
- <literal>MultiLineString(<replaceable>ls1</replaceable>,<replaceable>ls2</replaceable>,...)</literal>
+ <function role="sql">MultiLineString(<replaceable>ls1</replaceable>,<replaceable>ls2</replaceable>,...)</function>
</para>
<para>
@@ -2532,7 +2532,7 @@
<primary>MultiPoint()</primary>
</indexterm>
- <literal>MultiPoint(<replaceable>pt1</replaceable>,<replaceable>pt2</replaceable>,...)</literal>
+ <function role="sql">MultiPoint(<replaceable>pt1</replaceable>,<replaceable>pt2</replaceable>,...)</function>
</para>
<para>
@@ -2555,7 +2555,7 @@
<primary>MultiPolygon()</primary>
</indexterm>
- <literal>MultiPolygon(<replaceable>poly1</replaceable>,<replaceable>poly2</replaceable>,...)</literal>
+ <function role="sql">MultiPolygon(<replaceable>poly1</replaceable>,<replaceable>poly2</replaceable>,...)</function>
</para>
<para>
@@ -2578,7 +2578,7 @@
<primary>Point()</primary>
</indexterm>
- <literal>Point(<replaceable>x</replaceable>,<replaceable>y</replaceable>)</literal>
+ <function role="sql">Point(<replaceable>x</replaceable>,<replaceable>y</replaceable>)</function>
</para>
<para>
@@ -2599,7 +2599,7 @@
<primary>Polygon()</primary>
</indexterm>
- <literal>Polygon(<replaceable>ls1</replaceable>,<replaceable>ls2</replaceable>,...)</literal>
+ <function role="sql">Polygon(<replaceable>ls1</replaceable>,<replaceable>ls2</replaceable>,...)</function>
</para>
<para>
@@ -2840,8 +2840,8 @@
</para>
<para>
- The <literal>AsText()</literal> function converts a geometry
- from internal format into a WKT string.
+ The <function role="sql">AsText()</function> function
+ converts a geometry from internal format into a WKT string.
</para>
<programlisting>
@@ -2855,9 +2855,9 @@
</para>
<para>
- The <literal>AsBinary()</literal> function converts a
- geometry from internal format into a <literal>BLOB</literal>
- containing the WKB value.
+ The <function role="sql">AsBinary()</function> function
+ converts a geometry from internal format into a
+ <literal>BLOB</literal> containing the WKB value.
</para>
<programlisting>
@@ -2957,7 +2957,7 @@
<primary>AsBinary()</primary>
</indexterm>
- <literal>AsBinary(<replaceable>g</replaceable>)</literal>
+ <function role="sql">AsBinary(<replaceable>g</replaceable>)</function>
</para>
<para>
@@ -2986,7 +2986,7 @@
<primary>AsText()</primary>
</indexterm>
- <literal>AsText(<replaceable>g</replaceable>)</literal>
+ <function role="sql">AsText(<replaceable>g</replaceable>)</function>
</para>
<para>
@@ -3022,8 +3022,8 @@
Converts a string value from its WKT representation into
internal geometry format and returns the result. A number of
type-specific functions are also supported, such as
- <literal>PointFromText()</literal> and
- <literal>LineFromText()</literal>. See
+ <function role="sql">PointFromText()</function> and
+ <function role="sql">LineFromText()</function>. See
<xref linkend="gis-wkt-functions"/>.
</para>
</listitem>
@@ -3034,15 +3034,15 @@
<primary>GeomFromWKB()</primary>
</indexterm>
- <literal>GeomFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</literal>
+ <function role="sql">GeomFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</function>
</para>
<para>
Converts a binary value from its WKB representation into
internal geometry format and returns the result. A number of
type-specific functions are also supported, such as
- <literal>PointFromWKB()</literal> and
- <literal>LineFromWKB()</literal>. See
+ <function role="sql">PointFromWKB()</function> and
+ <function role="sql">LineFromWKB()</function>. See
<xref linkend="gis-wkb-functions"/>.
</para>
</listitem>
@@ -3061,9 +3061,9 @@
property of the geometry. Some functions restrict their argument
type. Such functions return <literal>NULL</literal> if the
argument is of an incorrect geometry type. For example,
- <literal>Area()</literal> returns <literal>NULL</literal> if the
- object type is neither <literal>Polygon</literal> nor
- <literal>MultiPolygon</literal>.
+ <function role="sql">Area()</function> returns
+ <literal>NULL</literal> if the object type is neither
+ <literal>Polygon</literal> nor <literal>MultiPolygon</literal>.
</para>
<section id="general-geometry-property-functions">
@@ -3089,7 +3089,7 @@
<primary>Dimension()</primary>
</indexterm>
- <literal>Dimension(<replaceable>g</replaceable>)</literal>
+ <function role="sql">Dimension(<replaceable>g</replaceable>)</function>
</para>
<para>
@@ -3123,7 +3123,7 @@
<primary>Envelope()</primary>
</indexterm>
- <literal>Envelope(<replaceable>g</replaceable>)</literal>
+ <function role="sql">Envelope(<replaceable>g</replaceable>)</function>
</para>
<para>
@@ -3165,7 +3165,7 @@
<primary>GeometryType()</primary>
</indexterm>
- <literal>GeometryType(<replaceable>g</replaceable>)</literal>
+ <function role="sql">GeometryType(<replaceable>g</replaceable>)</function>
</para>
<para>
@@ -3199,7 +3199,7 @@
<primary>SRID()</primary>
</indexterm>
- <literal>SRID(<replaceable>g</replaceable>)</literal>
+ <function role="sql">SRID(<replaceable>g</replaceable>)</function>
</para>
<para>
@@ -3246,7 +3246,7 @@
<primary>Boundary()</primary>
</indexterm>
- <literal>Boundary(<replaceable>g</replaceable>)</literal>
+ <function role="sql">Boundary(<replaceable>g</replaceable>)</function>
</para>
<para>
@@ -3268,7 +3268,7 @@
<primary>IsEmpty()</primary>
</indexterm>
- <literal>IsEmpty(<replaceable>g</replaceable>)</literal>
+ <function role="sql">IsEmpty(<replaceable>g</replaceable>)</function>
</para>
<para>
@@ -3292,7 +3292,7 @@
<primary>IsSimple()</primary>
</indexterm>
- <literal>IsSimple(<replaceable>g</replaceable>)</literal>
+ <function role="sql">IsSimple(<replaceable>g</replaceable>)</function>
</para>
<para>
@@ -3305,8 +3305,9 @@
Returns 1 if the geometry value
<replaceable>g</replaceable> has no anomalous geometric
points, such as self-intersection or self-tangency.
- <literal>IsSimple()</literal> returns 0 if the argument is
- not simple, and −1 if it is <literal>NULL</literal>.
+ <function role="sql">IsSimple()</function> returns 0 if
+ the argument is not simple, and −1 if it is
+ <literal>NULL</literal>.
</para>
<para>
@@ -3347,7 +3348,7 @@
<primary>X()</primary>
</indexterm>
- <literal>X(<replaceable>p</replaceable>)</literal>
+ <function role="sql">X(<replaceable>p</replaceable>)</function>
</para>
<para>
@@ -3380,7 +3381,7 @@
<primary>Y()</primary>
</indexterm>
- <literal>Y(<replaceable>p</replaceable>)</literal>
+ <function role="sql">Y(<replaceable>p</replaceable>)</function>
</para>
<para>
@@ -3432,7 +3433,7 @@
<primary>EndPoint()</primary>
</indexterm>
- <literal>EndPoint(<replaceable>ls</replaceable>)</literal>
+ <function role="sql">EndPoint(<replaceable>ls</replaceable>)</function>
</para>
<para>
@@ -3466,7 +3467,7 @@
<primary>GLength()</primary>
</indexterm>
- <literal>GLength(<replaceable>ls</replaceable>)</literal>
+ <function role="sql">GLength(<replaceable>ls</replaceable>)</function>
</para>
<para>
@@ -3491,9 +3492,9 @@
</programlisting>
<para>
- <literal>GLength()</literal> is a non-standard name. It
- corresponds to the OpenGIS <literal>Length()</literal>
- function.
+ <function role="sql">GLength()</function> is a
+ non-standard name. It corresponds to the OpenGIS
+ <function role="sql">Length()</function> function.
</para>
</listitem>
@@ -3507,7 +3508,7 @@
<primary>NumPoints()</primary>
</indexterm>
- <literal>NumPoints(<replaceable>ls</replaceable>)</literal>
+ <function role="sql">NumPoints(<replaceable>ls</replaceable>)</function>
</para>
<para>
@@ -3541,7 +3542,7 @@
<primary>PointN()</primary>
</indexterm>
- <literal>PointN(<replaceable>ls</replaceable>,<replaceable>N</replaceable>)</literal>
+ <function role="sql">PointN(<replaceable>ls</replaceable>,<replaceable>N</replaceable>)</function>
</para>
<para>
@@ -3616,17 +3617,18 @@
<primary>IsRing()</primary>
</indexterm>
- <literal>IsRing(<replaceable>ls</replaceable>)</literal>
+ <function role="sql">IsRing(<replaceable>ls</replaceable>)</function>
</para>
<para>
Returns 1 if the <literal>LineString</literal> value
<replaceable>ls</replaceable> is closed (that is, its
<function role="sql">StartPoint()</function> and
- <literal>EndPoint()</literal> values are the same) and is
- simple (does not pass through the same point more than
- once). Returns 0 if <replaceable>ls</replaceable> is not a
- ring, and −1 if it is <literal>NULL</literal>.
+ <function role="sql">EndPoint()</function> values are the
+ same) and is simple (does not pass through the same point
+ more than once). Returns 0 if
+ <replaceable>ls</replaceable> is not a ring, and −1
+ if it is <literal>NULL</literal>.
</para>
</listitem>
@@ -3656,7 +3658,7 @@
<primary>GLength()</primary>
</indexterm>
- <literal>GLength(<replaceable>mls</replaceable>)</literal>
+ <function role="sql">GLength(<replaceable>mls</replaceable>)</function>
</para>
<para>
@@ -3678,9 +3680,9 @@
</programlisting>
<para>
- <literal>GLength()</literal> is a non-standard name. It
- corresponds to the OpenGIS <literal>Length()</literal>
- function.
+ <function role="sql">GLength()</function> is a
+ non-standard name. It corresponds to the OpenGIS
+ <function role="sql">Length()</function> function.
</para>
</listitem>
@@ -3690,15 +3692,15 @@
<primary>IsClosed()</primary>
</indexterm>
- <literal>IsClosed(<replaceable>mls</replaceable>)</literal>
+ <function role="sql">IsClosed(<replaceable>mls</replaceable>)</function>
</para>
<para>
Returns 1 if the <literal>MultiLineString</literal> value
<replaceable>mls</replaceable> is closed (that is, the
<function role="sql">StartPoint()</function> and
- <literal>EndPoint()</literal> values are the same for each
- <literal>LineString</literal> in
+ <function role="sql">EndPoint()</function> values are the
+ same for each <literal>LineString</literal> in
<replaceable>mls</replaceable>). Returns 0 if
<replaceable>mls</replaceable> is not closed, and −1
if it is <literal>NULL</literal>.
@@ -3741,7 +3743,7 @@
<primary>Area()</primary>
</indexterm>
- <literal>Area(<replaceable>poly</replaceable>)</literal>
+ <function role="sql">Area(<replaceable>poly</replaceable>)</function>
</para>
<para>
@@ -3776,7 +3778,7 @@
<primary>ExteriorRing()</primary>
</indexterm>
- <literal>ExteriorRing(<replaceable>poly</replaceable>)</literal>
+ <function role="sql">ExteriorRing(<replaceable>poly</replaceable>)</function>
</para>
<para>
@@ -3812,7 +3814,7 @@
<primary>InteriorRingN()</primary>
</indexterm>
- <literal>InteriorRingN(<replaceable>poly</replaceable>,<replaceable>N</replaceable>)</literal>
+ <function role="sql">InteriorRingN(<replaceable>poly</replaceable>,<replaceable>N</replaceable>)</function>
</para>
<para>
@@ -3849,7 +3851,7 @@
<primary>NumInteriorRings()</primary>
</indexterm>
- <literal>NumInteriorRings(<replaceable>poly</replaceable>)</literal>
+ <function role="sql">NumInteriorRings(<replaceable>poly</replaceable>)</function>
</para>
<para>
@@ -3894,7 +3896,7 @@
<primary>Area()</primary>
</indexterm>
- <literal>Area(<replaceable>mpoly</replaceable>)</literal>
+ <function role="sql">Area(<replaceable>mpoly</replaceable>)</function>
</para>
<para>
@@ -3931,7 +3933,7 @@
<primary>Centroid()</primary>
</indexterm>
- <literal>Centroid(<replaceable>mpoly</replaceable>)</literal>
+ <function role="sql">Centroid(<replaceable>mpoly</replaceable>)</function>
</para>
<para>
@@ -3985,7 +3987,7 @@
<primary>GeometryN()</primary>
</indexterm>
- <literal>GeometryN(<replaceable>gc</replaceable>,<replaceable>N</replaceable>)</literal>
+ <function role="sql">GeometryN(<replaceable>gc</replaceable>,<replaceable>N</replaceable>)</function>
</para>
<para>
@@ -4020,7 +4022,7 @@
<primary>NumGeometries()</primary>
</indexterm>
- <literal>NumGeometries(<replaceable>gc</replaceable>)</literal>
+ <function role="sql">NumGeometries(<replaceable>gc</replaceable>)</function>
</para>
<para>
@@ -4143,7 +4145,7 @@
<primary>Buffer()</primary>
</indexterm>
- <literal>Buffer(<replaceable>g</replaceable>,<replaceable>d</replaceable>)</literal>
+ <function role="sql">Buffer(<replaceable>g</replaceable>,<replaceable>d</replaceable>)</function>
</para>
<para>
@@ -4165,7 +4167,7 @@
<primary>ConvexHull()</primary>
</indexterm>
- <literal>ConvexHull(<replaceable>g</replaceable>)</literal>
+ <function role="sql">ConvexHull(<replaceable>g</replaceable>)</function>
</para>
<para>
@@ -4185,7 +4187,7 @@
<primary>Difference()</primary>
</indexterm>
- <literal>Difference(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">Difference(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4207,7 +4209,7 @@
<primary>Intersection()</primary>
</indexterm>
- <literal>Intersection(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">Intersection(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4229,7 +4231,7 @@
<primary>SymDifference()</primary>
</indexterm>
- <literal>SymDifference(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">SymDifference(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4251,7 +4253,7 @@
<primary>Union()</primary>
</indexterm>
- <literal>Union(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">Union(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4312,7 +4314,7 @@
<primary>MBRContains()</primary>
</indexterm>
- <literal>MBRContains(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">MBRContains(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4320,7 +4322,7 @@
Rectangle of <replaceable>g1</replaceable> contains the
Minimum Bounding Rectangle of <replaceable>g2</replaceable>.
This tests the opposite relationship as
- <literal>MBRWithin()</literal>.
+ <function role="sql">MBRWithin()</function>.
</para>
<remark role="help-description-end"/>
@@ -4349,7 +4351,7 @@
<primary>MBRDisjoint()</primary>
</indexterm>
- <literal>MBRDisjoint(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">MBRDisjoint(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4373,7 +4375,7 @@
<primary>MBREqual()</primary>
</indexterm>
- <literal>MBREqual(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">MBREqual(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4396,7 +4398,7 @@
<primary>MBRIntersects()</primary>
</indexterm>
- <literal>MBRIntersects(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">MBRIntersects(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4419,7 +4421,7 @@
<primary>MBROverlaps()</primary>
</indexterm>
- <literal>MBROverlaps(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">MBROverlaps(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4446,7 +4448,7 @@
<primary>MBRTouches()</primary>
</indexterm>
- <literal>MBRTouches(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">MBRTouches(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4473,7 +4475,7 @@
<primary>MBRWithin()</primary>
</indexterm>
- <literal>MBRWithin(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">MBRWithin(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4481,7 +4483,7 @@
Rectangle of <replaceable>g1</replaceable> is within the
Minimum Bounding Rectangle of <replaceable>g2</replaceable>.
This tests the opposite relationship as
- <literal>MBRContains()</literal>.
+ <function role="sql">MBRContains()</function>.
</para>
<remark role="help-description-end"/>
@@ -4524,8 +4526,8 @@
to the specification. Those that are implemented return the
same result as the corresponding MBR-based functions. This
includes functions in the following list other than
- <literal>Distance()</literal> and
- <literal>Related()</literal>.
+ <function role="sql">Distance()</function> and
+ <function role="sql">Related()</function>.
</para>
<remark role="note">
@@ -4553,14 +4555,14 @@
<primary>Contains()</primary>
</indexterm>
- <literal>Contains(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">Contains(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
Returns 1 or 0 to indicate whether
<replaceable>g1</replaceable> completely contains
<replaceable>g2</replaceable>. This tests the opposite
- relationship as <literal>Within()</literal>.
+ relationship as <function role="sql">Within()</function>.
</para>
<remark role="help-description-end"/>
@@ -4576,7 +4578,7 @@
<primary>Crosses()</primary>
</indexterm>
- <literal>Crosses(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">Crosses(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4633,7 +4635,7 @@
<primary>Disjoint()</primary>
</indexterm>
- <literal>Disjoint(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">Disjoint(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4656,7 +4658,7 @@
<primary>Distance()</primary>
</indexterm>
- <literal>Distance(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">Distance(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4675,7 +4677,7 @@
<primary>Equals()</primary>
</indexterm>
- <literal>Equals(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">Equals(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4697,7 +4699,7 @@
<primary>Intersects()</primary>
</indexterm>
- <literal>Intersects(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">Intersects(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4719,7 +4721,7 @@
<primary>Overlaps()</primary>
</indexterm>
- <literal>Overlaps(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">Overlaps(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4769,7 +4771,7 @@
<primary>Touches()</primary>
</indexterm>
- <literal>Touches(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">Touches(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4795,14 +4797,14 @@
<primary>Within()</primary>
</indexterm>
- <literal>Within(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">Within(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
Returns 1 or 0 to indicate whether
<replaceable>g1</replaceable> is spatially within
<replaceable>g2</replaceable>. This tests the opposite
- relationship as <literal>Contains()</literal>.
+ relationship as <function role="sql">Contains()</function>.
</para>
<remark role="help-description-end"/>
@@ -5004,10 +5006,10 @@
<para>
The optimizer investigates whether available spatial indexes can
be involved in the search for queries that use a function such
- as <literal>MBRContains()</literal> or
- <literal>MBRWithin()</literal> in the <literal>WHERE</literal>
- clause. The following query finds all objects that are in the
- given rectangle:
+ as <function role="sql">MBRContains()</function> or
+ <function role="sql">MBRWithin()</function> in the
+ <literal>WHERE</literal> clause. The following query finds all
+ objects that are in the given rectangle:
</para>
<programlisting>
@@ -5176,19 +5178,19 @@
<listitem>
<para>
- The OpenGIS function <literal>Length()</literal> on
- <literal>LineString</literal> and
+ The OpenGIS function <function role="sql">Length()</function>
+ on <literal>LineString</literal> and
<literal>MultiLineString</literal> currently should be called
- in MySQL as <literal>GLength()</literal>
+ in MySQL as <function role="sql">GLength()</function>
</para>
<para>
The problem is that there is an existing SQL function
- <literal>Length()</literal> that calculates the length of
- string values, and sometimes it is not possible to distinguish
- whether the function is called in a textual or spatial
- context. We need either to solve this somehow, or decide on
- another function name.
+ <function role="sql">Length()</function> that calculates the
+ length of string values, and sometimes it is not possible to
+ distinguish whether the function is called in a textual or
+ spatial context. We need either to solve this somehow, or
+ decide on another function name.
</para>
</listitem>
Modified: trunk/refman-5.0/spatial-extensions.xml
===================================================================
--- trunk/refman-5.0/spatial-extensions.xml 2008-01-26 00:31:52 UTC (rev 9640)
+++ trunk/refman-5.0/spatial-extensions.xml 2008-01-26 00:32:49 UTC (rev 9641)
Changed blocks: 89, Lines Added: 139, Lines Deleted: 137; 39651 bytes
@@ -1929,8 +1929,8 @@
<primary>LineStringFromText()</primary>
</indexterm>
- <literal>LineFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</literal>,
- <literal>LineStringFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</literal>
+ <function role="sql">LineFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</function>,
+ <function role="sql" condition="linefromtext">LineStringFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</function>
</para>
<para>
@@ -1959,8 +1959,8 @@
<primary>MultiLineStringFromText()</primary>
</indexterm>
- <literal>MLineFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</literal>,
- <literal>MultiLineStringFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</literal>
+ <function role="sql">MLineFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</function>,
+ <function role="sql" condition="mlinefromtext">MultiLineStringFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</function>
</para>
<para>
@@ -1989,8 +1989,8 @@
<primary>MultiPointFromText()</primary>
</indexterm>
- <literal>MPointFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</literal>,
- <literal>MultiPointFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</literal>
+ <function role="sql">MPointFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</function>,
+ <function role="sql" condition="mpointfromtext">MultiPointFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</function>
</para>
<para>
@@ -2019,8 +2019,8 @@
<primary>MultiPolygonFromText()</primary>
</indexterm>
- <literal>MPolyFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</literal>,
- <literal>MultiPolygonFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</literal>
+ <function role="sql">MPolyFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</function>,
+ <function role="sql" condition="mpolyfromtext">MultiPolygonFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</function>
</para>
<para>
@@ -2041,7 +2041,7 @@
<primary>PointFromText()</primary>
</indexterm>
- <literal>PointFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</literal>
+ <function role="sql">PointFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</function>
</para>
<para>
@@ -2070,8 +2070,8 @@
<primary>PolygonFromText()</primary>
</indexterm>
- <literal>PolyFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</literal>,
- <literal>PolygonFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</literal>
+ <function role="sql">PolyFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</function>,
+ <function role="sql" condition="polyfromtext">PolygonFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</function>
</para>
<para>
@@ -2102,7 +2102,7 @@
<primary>BdMPolyFromText()</primary>
</indexterm>
- <literal>BdMPolyFromText(<replaceable>wkt</replaceable>,<replaceable>srid</replaceable>)</literal>
+ <function role="sql">BdMPolyFromText(<replaceable>wkt</replaceable>,<replaceable>srid</replaceable>)</function>
</para>
<para>
@@ -2119,7 +2119,7 @@
<primary>BdPolyFromText()</primary>
</indexterm>
- <literal>BdPolyFromText(<replaceable>wkt</replaceable>,<replaceable>srid</replaceable>)</literal>
+ <function role="sql">BdPolyFromText(<replaceable>wkt</replaceable>,<replaceable>srid</replaceable>)</function>
</para>
<para>
@@ -2147,10 +2147,10 @@
</para>
<para>
- <literal>GeomFromWKB()</literal> accepts a WKB of any geometry
- type as its first argument. An implementation also provides
- type-specific construction functions for construction of
- geometry values of each geometry type.
+ <function role="sql">GeomFromWKB()</function> accepts a WKB of
+ any geometry type as its first argument. An implementation
+ also provides type-specific construction functions for
+ construction of geometry values of each geometry type.
</para>
<remark role="help-category" condition="WKB@Geographic Features"/>
@@ -2175,8 +2175,8 @@
<primary>GeometryCollectionFromWKB()</primary>
</indexterm>
- <literal>GeomCollFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</literal>,
- <literal>GeometryCollectionFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</literal>
+ <function role="sql">GeomCollFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</function>,
+ <function role="sql" condition="geomcollfromwkb">GeometryCollectionFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</function>
</para>
<para>
@@ -2205,8 +2205,8 @@
<primary>GeometryFromWKB()</primary>
</indexterm>
- <literal>GeomFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</literal>,
- <literal>GeometryFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</literal>
+ <function role="sql">GeomFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</function>,
+ <function role="sql" condition="geomfromwkb">GeometryFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</function>
</para>
<para>
@@ -2235,8 +2235,8 @@
<primary>LineStringFromWKB()</primary>
</indexterm>
- <literal>LineFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</literal>,
- <literal>LineStringFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</literal>
+ <function role="sql">LineFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</function>,
+ <function role="sql" condition="linefromwkb">LineStringFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</function>
</para>
<para>
@@ -2265,8 +2265,8 @@
<primary>MultiLineStringFromWKB()</primary>
</indexterm>
- <literal>MLineFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</literal>,
- <literal>MultiLineStringFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</literal>
+ <function role="sql">MLineFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</function>,
+ <function role="sql" condition="mlinefromwkb">MultiLineStringFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</function>
</para>
<para>
@@ -2295,8 +2295,8 @@
<primary>MultiPointFromWKB()</primary>
</indexterm>
- <literal>MPointFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</literal>,
- <literal>MultiPointFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</literal>
+ <function role="sql">MPointFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</function>,
+ <function role="sql" condition="mpointfromwkb">MultiPointFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</function>
</para>
<para>
@@ -2316,7 +2316,7 @@
<remark role="help-description-begin"/>
- <para id="function_mpolyfromwbk">
+ <para id="function_mpolyfromwkb">
<indexterm>
<primary>MPolyFromWKB()</primary>
</indexterm>
@@ -2325,8 +2325,8 @@
<primary>MultiPolygonFromWKB()</primary>
</indexterm>
- <literal>MPolyFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</literal>,
- <literal>MultiPolygonFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</literal>
+ <function role="sql">MPolyFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</function>,
+ <function role="sql" condition="mpolyfromwkb">MultiPolygonFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</function>
</para>
<para>
@@ -2351,7 +2351,7 @@
<primary>PointFromWKB()</primary>
</indexterm>
- <literal>PointFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</literal>
+ <function role="sql">PointFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</function>
</para>
<para>
@@ -2380,8 +2380,8 @@
<primary>PolygonFromWKB()</primary>
</indexterm>
- <literal>PolyFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</literal>,
- <literal>PolygonFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</literal>
+ <function role="sql">PolyFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</function>,
+ <function role="sql" condition="polyfromwkb">PolygonFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</function>
</para>
<para>
@@ -2411,7 +2411,7 @@
<primary>BdMPolyFromWKB()</primary>
</indexterm>
- <literal>BdMPolyFromWKB(<replaceable>wkb</replaceable>,<replaceable>srid</replaceable>)</literal>
+ <function role="sql">BdMPolyFromWKB(<replaceable>wkb</replaceable>,<replaceable>srid</replaceable>)</function>
</para>
<para>
@@ -2428,7 +2428,7 @@
<primary>BdPolyFromWKB()</primary>
</indexterm>
- <literal>BdPolyFromWKB(<replaceable>wkb</replaceable>,<replaceable>srid</replaceable>)</literal>
+ <function role="sql">BdPolyFromWKB(<replaceable>wkb</replaceable>,<replaceable>srid</replaceable>)</function>
</para>
<para>
@@ -2455,8 +2455,8 @@
<literal>BLOB</literal> values containing WKB representations
of geometry values with no SRID. The results of these
functions can be substituted as the first argument for any
- function in the <literal>GeomFromWKB()</literal> function
- family.
+ function in the <function role="sql">GeomFromWKB()</function>
+ function family.
</para>
<remark role="help-category" condition="Geometry constructors@Geographic Features"/>
@@ -2473,7 +2473,7 @@
<primary>GeometryCollection()</primary>
</indexterm>
- <literal>GeometryCollection(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>,...)</literal>
+ <function role="sql">GeometryCollection(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>,...)</function>
</para>
<para>
@@ -2495,7 +2495,7 @@
<primary>LineString()</primary>
</indexterm>
- <literal>LineString(<replaceable>pt1</replaceable>,<replaceable>pt2</replaceable>,...)</literal>
+ <function role="sql">LineString(<replaceable>pt1</replaceable>,<replaceable>pt2</replaceable>,...)</function>
</para>
<para>
@@ -2520,7 +2520,7 @@
<primary>MultiLineString()</primary>
</indexterm>
- <literal>MultiLineString(<replaceable>ls1</replaceable>,<replaceable>ls2</replaceable>,...)</literal>
+ <function role="sql">MultiLineString(<replaceable>ls1</replaceable>,<replaceable>ls2</replaceable>,...)</function>
</para>
<para>
@@ -2543,7 +2543,7 @@
<primary>MultiPoint()</primary>
</indexterm>
- <literal>MultiPoint(<replaceable>pt1</replaceable>,<replaceable>pt2</replaceable>,...)</literal>
+ <function role="sql">MultiPoint(<replaceable>pt1</replaceable>,<replaceable>pt2</replaceable>,...)</function>
</para>
<para>
@@ -2566,7 +2566,7 @@
<primary>MultiPolygon()</primary>
</indexterm>
- <literal>MultiPolygon(<replaceable>poly1</replaceable>,<replaceable>poly2</replaceable>,...)</literal>
+ <function role="sql">MultiPolygon(<replaceable>poly1</replaceable>,<replaceable>poly2</replaceable>,...)</function>
</para>
<para>
@@ -2589,7 +2589,7 @@
<primary>Point()</primary>
</indexterm>
- <literal>Point(<replaceable>x</replaceable>,<replaceable>y</replaceable>)</literal>
+ <function role="sql">Point(<replaceable>x</replaceable>,<replaceable>y</replaceable>)</function>
</para>
<para>
@@ -2610,7 +2610,7 @@
<primary>Polygon()</primary>
</indexterm>
- <literal>Polygon(<replaceable>ls1</replaceable>,<replaceable>ls2</replaceable>,...)</literal>
+ <function role="sql">Polygon(<replaceable>ls1</replaceable>,<replaceable>ls2</replaceable>,...)</function>
</para>
<para>
@@ -2856,8 +2856,8 @@
</para>
<para>
- The <literal>AsText()</literal> function converts a geometry
- from internal format into a WKT string.
+ The <function role="sql">AsText()</function> function
+ converts a geometry from internal format into a WKT string.
</para>
<programlisting>
@@ -2871,9 +2871,9 @@
</para>
<para>
- The <literal>AsBinary()</literal> function converts a
- geometry from internal format into a <literal>BLOB</literal>
- containing the WKB value.
+ The <function role="sql">AsBinary()</function> function
+ converts a geometry from internal format into a
+ <literal>BLOB</literal> containing the WKB value.
</para>
<programlisting>
@@ -2973,7 +2973,7 @@
<primary>AsBinary()</primary>
</indexterm>
- <literal>AsBinary(<replaceable>g</replaceable>)</literal>
+ <function role="sql">AsBinary(<replaceable>g</replaceable>)</function>
</para>
<para>
@@ -3002,7 +3002,7 @@
<primary>AsText()</primary>
</indexterm>
- <literal>AsText(<replaceable>g</replaceable>)</literal>
+ <function role="sql">AsText(<replaceable>g</replaceable>)</function>
</para>
<para>
@@ -3038,8 +3038,8 @@
Converts a string value from its WKT representation into
internal geometry format and returns the result. A number of
type-specific functions are also supported, such as
- <literal>PointFromText()</literal> and
- <literal>LineFromText()</literal>. See
+ <function role="sql">PointFromText()</function> and
+ <function role="sql">LineFromText()</function>. See
<xref linkend="gis-wkt-functions"/>.
</para>
</listitem>
@@ -3050,15 +3050,15 @@
<primary>GeomFromWKB()</primary>
</indexterm>
- <literal>GeomFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</literal>
+ <function role="sql">GeomFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</function>
</para>
<para>
Converts a binary value from its WKB representation into
internal geometry format and returns the result. A number of
type-specific functions are also supported, such as
- <literal>PointFromWKB()</literal> and
- <literal>LineFromWKB()</literal>. See
+ <function role="sql">PointFromWKB()</function> and
+ <function role="sql">LineFromWKB()</function>. See
<xref linkend="gis-wkb-functions"/>.
</para>
</listitem>
@@ -3077,9 +3077,9 @@
property of the geometry. Some functions restrict their argument
type. Such functions return <literal>NULL</literal> if the
argument is of an incorrect geometry type. For example,
- <literal>Area()</literal> returns <literal>NULL</literal> if the
- object type is neither <literal>Polygon</literal> nor
- <literal>MultiPolygon</literal>.
+ <function role="sql">Area()</function> returns
+ <literal>NULL</literal> if the object type is neither
+ <literal>Polygon</literal> nor <literal>MultiPolygon</literal>.
</para>
<section id="general-geometry-property-functions">
@@ -3105,7 +3105,7 @@
<primary>Dimension()</primary>
</indexterm>
- <literal>Dimension(<replaceable>g</replaceable>)</literal>
+ <function role="sql">Dimension(<replaceable>g</replaceable>)</function>
</para>
<para>
@@ -3139,7 +3139,7 @@
<primary>Envelope()</primary>
</indexterm>
- <literal>Envelope(<replaceable>g</replaceable>)</literal>
+ <function role="sql">Envelope(<replaceable>g</replaceable>)</function>
</para>
<para>
@@ -3181,7 +3181,7 @@
<primary>GeometryType()</primary>
</indexterm>
- <literal>GeometryType(<replaceable>g</replaceable>)</literal>
+ <function role="sql">GeometryType(<replaceable>g</replaceable>)</function>
</para>
<para>
@@ -3215,7 +3215,7 @@
<primary>SRID()</primary>
</indexterm>
- <literal>SRID(<replaceable>g</replaceable>)</literal>
+ <function role="sql">SRID(<replaceable>g</replaceable>)</function>
</para>
<para>
@@ -3262,7 +3262,7 @@
<primary>Boundary()</primary>
</indexterm>
- <literal>Boundary(<replaceable>g</replaceable>)</literal>
+ <function role="sql">Boundary(<replaceable>g</replaceable>)</function>
</para>
<para>
@@ -3284,7 +3284,7 @@
<primary>IsEmpty()</primary>
</indexterm>
- <literal>IsEmpty(<replaceable>g</replaceable>)</literal>
+ <function role="sql">IsEmpty(<replaceable>g</replaceable>)</function>
</para>
<para>
@@ -3308,7 +3308,7 @@
<primary>IsSimple()</primary>
</indexterm>
- <literal>IsSimple(<replaceable>g</replaceable>)</literal>
+ <function role="sql">IsSimple(<replaceable>g</replaceable>)</function>
</para>
<para>
@@ -3321,8 +3321,9 @@
Returns 1 if the geometry value
<replaceable>g</replaceable> has no anomalous geometric
points, such as self-intersection or self-tangency.
- <literal>IsSimple()</literal> returns 0 if the argument is
- not simple, and −1 if it is <literal>NULL</literal>.
+ <function role="sql">IsSimple()</function> returns 0 if
+ the argument is not simple, and −1 if it is
+ <literal>NULL</literal>.
</para>
<para>
@@ -3363,7 +3364,7 @@
<primary>X()</primary>
</indexterm>
- <literal>X(<replaceable>p</replaceable>)</literal>
+ <function role="sql">X(<replaceable>p</replaceable>)</function>
</para>
<para>
@@ -3396,7 +3397,7 @@
<primary>Y()</primary>
</indexterm>
- <literal>Y(<replaceable>p</replaceable>)</literal>
+ <function role="sql">Y(<replaceable>p</replaceable>)</function>
</para>
<para>
@@ -3448,7 +3449,7 @@
<primary>EndPoint()</primary>
</indexterm>
- <literal>EndPoint(<replaceable>ls</replaceable>)</literal>
+ <function role="sql">EndPoint(<replaceable>ls</replaceable>)</function>
</para>
<para>
@@ -3482,7 +3483,7 @@
<primary>GLength()</primary>
</indexterm>
- <literal>GLength(<replaceable>ls</replaceable>)</literal>
+ <function role="sql">GLength(<replaceable>ls</replaceable>)</function>
</para>
<para>
@@ -3507,9 +3508,9 @@
</programlisting>
<para>
- <literal>GLength()</literal> is a non-standard name. It
- corresponds to the OpenGIS <literal>Length()</literal>
- function.
+ <function role="sql">GLength()</function> is a
+ non-standard name. It corresponds to the OpenGIS
+ <function role="sql">Length()</function> function.
</para>
</listitem>
@@ -3523,7 +3524,7 @@
<primary>NumPoints()</primary>
</indexterm>
- <literal>NumPoints(<replaceable>ls</replaceable>)</literal>
+ <function role="sql">NumPoints(<replaceable>ls</replaceable>)</function>
</para>
<para>
@@ -3557,7 +3558,7 @@
<primary>PointN()</primary>
</indexterm>
- <literal>PointN(<replaceable>ls</replaceable>,<replaceable>N</replaceable>)</literal>
+ <function role="sql">PointN(<replaceable>ls</replaceable>,<replaceable>N</replaceable>)</function>
</para>
<para>
@@ -3632,17 +3633,18 @@
<primary>IsRing()</primary>
</indexterm>
- <literal>IsRing(<replaceable>ls</replaceable>)</literal>
+ <function role="sql">IsRing(<replaceable>ls</replaceable>)</function>
</para>
<para>
Returns 1 if the <literal>LineString</literal> value
<replaceable>ls</replaceable> is closed (that is, its
<function role="sql">StartPoint()</function> and
- <literal>EndPoint()</literal> values are the same) and is
- simple (does not pass through the same point more than
- once). Returns 0 if <replaceable>ls</replaceable> is not a
- ring, and −1 if it is <literal>NULL</literal>.
+ <function role="sql">EndPoint()</function> values are the
+ same) and is simple (does not pass through the same point
+ more than once). Returns 0 if
+ <replaceable>ls</replaceable> is not a ring, and −1
+ if it is <literal>NULL</literal>.
</para>
</listitem>
@@ -3672,7 +3674,7 @@
<primary>GLength()</primary>
</indexterm>
- <literal>GLength(<replaceable>mls</replaceable>)</literal>
+ <function role="sql">GLength(<replaceable>mls</replaceable>)</function>
</para>
<para>
@@ -3694,9 +3696,9 @@
</programlisting>
<para>
- <literal>GLength()</literal> is a non-standard name. It
- corresponds to the OpenGIS <literal>Length()</literal>
- function.
+ <function role="sql">GLength()</function> is a
+ non-standard name. It corresponds to the OpenGIS
+ <function role="sql">Length()</function> function.
</para>
</listitem>
@@ -3706,15 +3708,15 @@
<primary>IsClosed()</primary>
</indexterm>
- <literal>IsClosed(<replaceable>mls</replaceable>)</literal>
+ <function role="sql">IsClosed(<replaceable>mls</replaceable>)</function>
</para>
<para>
Returns 1 if the <literal>MultiLineString</literal> value
<replaceable>mls</replaceable> is closed (that is, the
<function role="sql">StartPoint()</function> and
- <literal>EndPoint()</literal> values are the same for each
- <literal>LineString</literal> in
+ <function role="sql">EndPoint()</function> values are the
+ same for each <literal>LineString</literal> in
<replaceable>mls</replaceable>). Returns 0 if
<replaceable>mls</replaceable> is not closed, and −1
if it is <literal>NULL</literal>.
@@ -3757,7 +3759,7 @@
<primary>Area()</primary>
</indexterm>
- <literal>Area(<replaceable>poly</replaceable>)</literal>
+ <function role="sql">Area(<replaceable>poly</replaceable>)</function>
</para>
<para>
@@ -3792,7 +3794,7 @@
<primary>ExteriorRing()</primary>
</indexterm>
- <literal>ExteriorRing(<replaceable>poly</replaceable>)</literal>
+ <function role="sql">ExteriorRing(<replaceable>poly</replaceable>)</function>
</para>
<para>
@@ -3828,7 +3830,7 @@
<primary>InteriorRingN()</primary>
</indexterm>
- <literal>InteriorRingN(<replaceable>poly</replaceable>,<replaceable>N</replaceable>)</literal>
+ <function role="sql">InteriorRingN(<replaceable>poly</replaceable>,<replaceable>N</replaceable>)</function>
</para>
<para>
@@ -3865,7 +3867,7 @@
<primary>NumInteriorRings()</primary>
</indexterm>
- <literal>NumInteriorRings(<replaceable>poly</replaceable>)</literal>
+ <function role="sql">NumInteriorRings(<replaceable>poly</replaceable>)</function>
</para>
<para>
@@ -3910,7 +3912,7 @@
<primary>Area()</primary>
</indexterm>
- <literal>Area(<replaceable>mpoly</replaceable>)</literal>
+ <function role="sql">Area(<replaceable>mpoly</replaceable>)</function>
</para>
<para>
@@ -3947,7 +3949,7 @@
<primary>Centroid()</primary>
</indexterm>
- <literal>Centroid(<replaceable>mpoly</replaceable>)</literal>
+ <function role="sql">Centroid(<replaceable>mpoly</replaceable>)</function>
</para>
<para>
@@ -4001,7 +4003,7 @@
<primary>GeometryN()</primary>
</indexterm>
- <literal>GeometryN(<replaceable>gc</replaceable>,<replaceable>N</replaceable>)</literal>
+ <function role="sql">GeometryN(<replaceable>gc</replaceable>,<replaceable>N</replaceable>)</function>
</para>
<para>
@@ -4036,7 +4038,7 @@
<primary>NumGeometries()</primary>
</indexterm>
- <literal>NumGeometries(<replaceable>gc</replaceable>)</literal>
+ <function role="sql">NumGeometries(<replaceable>gc</replaceable>)</function>
</para>
<para>
@@ -4159,7 +4161,7 @@
<primary>Buffer()</primary>
</indexterm>
- <literal>Buffer(<replaceable>g</replaceable>,<replaceable>d</replaceable>)</literal>
+ <function role="sql">Buffer(<replaceable>g</replaceable>,<replaceable>d</replaceable>)</function>
</para>
<para>
@@ -4181,7 +4183,7 @@
<primary>ConvexHull()</primary>
</indexterm>
- <literal>ConvexHull(<replaceable>g</replaceable>)</literal>
+ <function role="sql">ConvexHull(<replaceable>g</replaceable>)</function>
</para>
<para>
@@ -4201,7 +4203,7 @@
<primary>Difference()</primary>
</indexterm>
- <literal>Difference(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">Difference(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4223,7 +4225,7 @@
<primary>Intersection()</primary>
</indexterm>
- <literal>Intersection(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">Intersection(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4245,7 +4247,7 @@
<primary>SymDifference()</primary>
</indexterm>
- <literal>SymDifference(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">SymDifference(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4267,7 +4269,7 @@
<primary>Union()</primary>
</indexterm>
- <literal>Union(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">Union(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4328,7 +4330,7 @@
<primary>MBRContains()</primary>
</indexterm>
- <literal>MBRContains(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">MBRContains(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4336,7 +4338,7 @@
Rectangle of <replaceable>g1</replaceable> contains the
Minimum Bounding Rectangle of <replaceable>g2</replaceable>.
This tests the opposite relationship as
- <literal>MBRWithin()</literal>.
+ <function role="sql">MBRWithin()</function>.
</para>
<remark role="help-description-end"/>
@@ -4365,7 +4367,7 @@
<primary>MBRDisjoint()</primary>
</indexterm>
- <literal>MBRDisjoint(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">MBRDisjoint(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4389,7 +4391,7 @@
<primary>MBREqual()</primary>
</indexterm>
- <literal>MBREqual(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">MBREqual(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4412,7 +4414,7 @@
<primary>MBRIntersects()</primary>
</indexterm>
- <literal>MBRIntersects(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">MBRIntersects(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4435,7 +4437,7 @@
<primary>MBROverlaps()</primary>
</indexterm>
- <literal>MBROverlaps(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">MBROverlaps(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4462,7 +4464,7 @@
<primary>MBRTouches()</primary>
</indexterm>
- <literal>MBRTouches(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">MBRTouches(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4489,7 +4491,7 @@
<primary>MBRWithin()</primary>
</indexterm>
- <literal>MBRWithin(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">MBRWithin(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4497,7 +4499,7 @@
Rectangle of <replaceable>g1</replaceable> is within the
Minimum Bounding Rectangle of <replaceable>g2</replaceable>.
This tests the opposite relationship as
- <literal>MBRContains()</literal>.
+ <function role="sql">MBRContains()</function>.
</para>
<remark role="help-description-end"/>
@@ -4540,8 +4542,8 @@
to the specification. Those that are implemented return the
same result as the corresponding MBR-based functions. This
includes functions in the following list other than
- <literal>Distance()</literal> and
- <literal>Related()</literal>.
+ <function role="sql">Distance()</function> and
+ <function role="sql">Related()</function>.
</para>
<remark role="note">
@@ -4569,14 +4571,14 @@
<primary>Contains()</primary>
</indexterm>
- <literal>Contains(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">Contains(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
Returns 1 or 0 to indicate whether
<replaceable>g1</replaceable> completely contains
<replaceable>g2</replaceable>. This tests the opposite
- relationship as <literal>Within()</literal>.
+ relationship as <function role="sql">Within()</function>.
</para>
<remark role="help-description-end"/>
@@ -4592,7 +4594,7 @@
<primary>Crosses()</primary>
</indexterm>
- <literal>Crosses(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">Crosses(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4649,7 +4651,7 @@
<primary>Disjoint()</primary>
</indexterm>
- <literal>Disjoint(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">Disjoint(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4672,7 +4674,7 @@
<primary>Distance()</primary>
</indexterm>
- <literal>Distance(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">Distance(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4691,7 +4693,7 @@
<primary>Equals()</primary>
</indexterm>
- <literal>Equals(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">Equals(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4713,7 +4715,7 @@
<primary>Intersects()</primary>
</indexterm>
- <literal>Intersects(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">Intersects(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4735,7 +4737,7 @@
<primary>Overlaps()</primary>
</indexterm>
- <literal>Overlaps(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">Overlaps(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4785,7 +4787,7 @@
<primary>Touches()</primary>
</indexterm>
- <literal>Touches(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">Touches(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4811,14 +4813,14 @@
<primary>Within()</primary>
</indexterm>
- <literal>Within(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">Within(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
Returns 1 or 0 to indicate whether
<replaceable>g1</replaceable> is spatially within
<replaceable>g2</replaceable>. This tests the opposite
- relationship as <literal>Contains()</literal>.
+ relationship as <function role="sql">Contains()</function>.
</para>
<remark role="help-description-end"/>
@@ -5034,10 +5036,10 @@
<para>
The optimizer investigates whether available spatial indexes can
be involved in the search for queries that use a function such
- as <literal>MBRContains()</literal> or
- <literal>MBRWithin()</literal> in the <literal>WHERE</literal>
- clause. The following query finds all objects that are in the
- given rectangle:
+ as <function role="sql">MBRContains()</function> or
+ <function role="sql">MBRWithin()</function> in the
+ <literal>WHERE</literal> clause. The following query finds all
+ objects that are in the given rectangle:
</para>
<programlisting>
@@ -5206,19 +5208,19 @@
<listitem>
<para>
- The OpenGIS function <literal>Length()</literal> on
- <literal>LineString</literal> and
+ The OpenGIS function <function role="sql">Length()</function>
+ on <literal>LineString</literal> and
<literal>MultiLineString</literal> currently should be called
- in MySQL as <literal>GLength()</literal>
+ in MySQL as <function role="sql">GLength()</function>
</para>
<para>
The problem is that there is an existing SQL function
- <literal>Length()</literal> that calculates the length of
- string values, and sometimes it is not possible to distinguish
- whether the function is called in a textual or spatial
- context. We need either to solve this somehow, or decide on
- another function name.
+ <function role="sql">Length()</function> that calculates the
+ length of string values, and sometimes it is not possible to
+ distinguish whether the function is called in a textual or
+ spatial context. We need either to solve this somehow, or
+ decide on another function name.
</para>
</listitem>
Modified: trunk/refman-5.1/spatial-extensions.xml
===================================================================
--- trunk/refman-5.1/spatial-extensions.xml 2008-01-26 00:31:52 UTC (rev 9640)
+++ trunk/refman-5.1/spatial-extensions.xml 2008-01-26 00:32:49 UTC (rev 9641)
Changed blocks: 89, Lines Added: 139, Lines Deleted: 137; 39651 bytes
@@ -1927,8 +1927,8 @@
<primary>LineStringFromText()</primary>
</indexterm>
- <literal>LineFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</literal>,
- <literal>LineStringFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</literal>
+ <function role="sql">LineFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</function>,
+ <function role="sql" condition="linefromtext">LineStringFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</function>
</para>
<para>
@@ -1957,8 +1957,8 @@
<primary>MultiLineStringFromText()</primary>
</indexterm>
- <literal>MLineFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</literal>,
- <literal>MultiLineStringFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</literal>
+ <function role="sql">MLineFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</function>,
+ <function role="sql" condition="mlinefromtext">MultiLineStringFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</function>
</para>
<para>
@@ -1987,8 +1987,8 @@
<primary>MultiPointFromText()</primary>
</indexterm>
- <literal>MPointFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</literal>,
- <literal>MultiPointFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</literal>
+ <function role="sql">MPointFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</function>,
+ <function role="sql" condition="mpointfromtext">MultiPointFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</function>
</para>
<para>
@@ -2017,8 +2017,8 @@
<primary>MultiPolygonFromText()</primary>
</indexterm>
- <literal>MPolyFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</literal>,
- <literal>MultiPolygonFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</literal>
+ <function role="sql">MPolyFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</function>,
+ <function role="sql" condition="mpolyfromtext">MultiPolygonFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</function>
</para>
<para>
@@ -2039,7 +2039,7 @@
<primary>PointFromText()</primary>
</indexterm>
- <literal>PointFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</literal>
+ <function role="sql">PointFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</function>
</para>
<para>
@@ -2068,8 +2068,8 @@
<primary>PolygonFromText()</primary>
</indexterm>
- <literal>PolyFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</literal>,
- <literal>PolygonFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</literal>
+ <function role="sql">PolyFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</function>,
+ <function role="sql" condition="polyfromtext">PolygonFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</function>
</para>
<para>
@@ -2100,7 +2100,7 @@
<primary>BdMPolyFromText()</primary>
</indexterm>
- <literal>BdMPolyFromText(<replaceable>wkt</replaceable>,<replaceable>srid</replaceable>)</literal>
+ <function role="sql">BdMPolyFromText(<replaceable>wkt</replaceable>,<replaceable>srid</replaceable>)</function>
</para>
<para>
@@ -2117,7 +2117,7 @@
<primary>BdPolyFromText()</primary>
</indexterm>
- <literal>BdPolyFromText(<replaceable>wkt</replaceable>,<replaceable>srid</replaceable>)</literal>
+ <function role="sql">BdPolyFromText(<replaceable>wkt</replaceable>,<replaceable>srid</replaceable>)</function>
</para>
<para>
@@ -2145,10 +2145,10 @@
</para>
<para>
- <literal>GeomFromWKB()</literal> accepts a WKB of any geometry
- type as its first argument. An implementation also provides
- type-specific construction functions for construction of
- geometry values of each geometry type.
+ <function role="sql">GeomFromWKB()</function> accepts a WKB of
+ any geometry type as its first argument. An implementation
+ also provides type-specific construction functions for
+ construction of geometry values of each geometry type.
</para>
<remark role="help-category" condition="WKB@Geographic Features"/>
@@ -2173,8 +2173,8 @@
<primary>GeometryCollectionFromWKB()</primary>
</indexterm>
- <literal>GeomCollFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</literal>,
- <literal>GeometryCollectionFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</literal>
+ <function role="sql">GeomCollFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</function>,
+ <function role="sql" condition="geomcollfromwkb">GeometryCollectionFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</function>
</para>
<para>
@@ -2203,8 +2203,8 @@
<primary>GeometryFromWKB()</primary>
</indexterm>
- <literal>GeomFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</literal>,
- <literal>GeometryFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</literal>
+ <function role="sql">GeomFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</function>,
+ <function role="sql" condition="geomfromwkb">GeometryFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</function>
</para>
<para>
@@ -2233,8 +2233,8 @@
<primary>LineStringFromWKB()</primary>
</indexterm>
- <literal>LineFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</literal>,
- <literal>LineStringFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</literal>
+ <function role="sql">LineFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</function>,
+ <function role="sql" condition="linefromwkb">LineStringFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</function>
</para>
<para>
@@ -2263,8 +2263,8 @@
<primary>MultiLineStringFromWKB()</primary>
</indexterm>
- <literal>MLineFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</literal>,
- <literal>MultiLineStringFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</literal>
+ <function role="sql">MLineFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</function>,
+ <function role="sql" condition="mlinefromwkb">MultiLineStringFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</function>
</para>
<para>
@@ -2293,8 +2293,8 @@
<primary>MultiPointFromWKB()</primary>
</indexterm>
- <literal>MPointFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</literal>,
- <literal>MultiPointFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</literal>
+ <function role="sql">MPointFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</function>,
+ <function role="sql" condition="mpointfromwkb">MultiPointFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</function>
</para>
<para>
@@ -2314,7 +2314,7 @@
<remark role="help-description-begin"/>
- <para id="function_mpolyfromwbk">
+ <para id="function_mpolyfromwkb">
<indexterm>
<primary>MPolyFromWKB()</primary>
</indexterm>
@@ -2323,8 +2323,8 @@
<primary>MultiPolygonFromWKB()</primary>
</indexterm>
- <literal>MPolyFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</literal>,
- <literal>MultiPolygonFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</literal>
+ <function role="sql">MPolyFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</function>,
+ <function role="sql" condition="mpolyfromwkb">MultiPolygonFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</function>
</para>
<para>
@@ -2349,7 +2349,7 @@
<primary>PointFromWKB()</primary>
</indexterm>
- <literal>PointFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</literal>
+ <function role="sql">PointFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</function>
</para>
<para>
@@ -2378,8 +2378,8 @@
<primary>PolygonFromWKB()</primary>
</indexterm>
- <literal>PolyFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</literal>,
- <literal>PolygonFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</literal>
+ <function role="sql">PolyFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</function>,
+ <function role="sql" condition="polyfromwkb">PolygonFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</function>
</para>
<para>
@@ -2409,7 +2409,7 @@
<primary>BdMPolyFromWKB()</primary>
</indexterm>
- <literal>BdMPolyFromWKB(<replaceable>wkb</replaceable>,<replaceable>srid</replaceable>)</literal>
+ <function role="sql">BdMPolyFromWKB(<replaceable>wkb</replaceable>,<replaceable>srid</replaceable>)</function>
</para>
<para>
@@ -2426,7 +2426,7 @@
<primary>BdPolyFromWKB()</primary>
</indexterm>
- <literal>BdPolyFromWKB(<replaceable>wkb</replaceable>,<replaceable>srid</replaceable>)</literal>
+ <function role="sql">BdPolyFromWKB(<replaceable>wkb</replaceable>,<replaceable>srid</replaceable>)</function>
</para>
<para>
@@ -2453,8 +2453,8 @@
<literal>BLOB</literal> values containing WKB representations
of geometry values with no SRID. The results of these
functions can be substituted as the first argument for any
- function in the <literal>GeomFromWKB()</literal> function
- family.
+ function in the <function role="sql">GeomFromWKB()</function>
+ function family.
</para>
<remark role="help-category" condition="Geometry constructors@Geographic Features"/>
@@ -2471,7 +2471,7 @@
<primary>GeometryCollection()</primary>
</indexterm>
- <literal>GeometryCollection(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>,...)</literal>
+ <function role="sql">GeometryCollection(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>,...)</function>
</para>
<para>
@@ -2493,7 +2493,7 @@
<primary>LineString()</primary>
</indexterm>
- <literal>LineString(<replaceable>pt1</replaceable>,<replaceable>pt2</replaceable>,...)</literal>
+ <function role="sql">LineString(<replaceable>pt1</replaceable>,<replaceable>pt2</replaceable>,...)</function>
</para>
<para>
@@ -2518,7 +2518,7 @@
<primary>MultiLineString()</primary>
</indexterm>
- <literal>MultiLineString(<replaceable>ls1</replaceable>,<replaceable>ls2</replaceable>,...)</literal>
+ <function role="sql">MultiLineString(<replaceable>ls1</replaceable>,<replaceable>ls2</replaceable>,...)</function>
</para>
<para>
@@ -2541,7 +2541,7 @@
<primary>MultiPoint()</primary>
</indexterm>
- <literal>MultiPoint(<replaceable>pt1</replaceable>,<replaceable>pt2</replaceable>,...)</literal>
+ <function role="sql">MultiPoint(<replaceable>pt1</replaceable>,<replaceable>pt2</replaceable>,...)</function>
</para>
<para>
@@ -2564,7 +2564,7 @@
<primary>MultiPolygon()</primary>
</indexterm>
- <literal>MultiPolygon(<replaceable>poly1</replaceable>,<replaceable>poly2</replaceable>,...)</literal>
+ <function role="sql">MultiPolygon(<replaceable>poly1</replaceable>,<replaceable>poly2</replaceable>,...)</function>
</para>
<para>
@@ -2587,7 +2587,7 @@
<primary>Point()</primary>
</indexterm>
- <literal>Point(<replaceable>x</replaceable>,<replaceable>y</replaceable>)</literal>
+ <function role="sql">Point(<replaceable>x</replaceable>,<replaceable>y</replaceable>)</function>
</para>
<para>
@@ -2608,7 +2608,7 @@
<primary>Polygon()</primary>
</indexterm>
- <literal>Polygon(<replaceable>ls1</replaceable>,<replaceable>ls2</replaceable>,...)</literal>
+ <function role="sql">Polygon(<replaceable>ls1</replaceable>,<replaceable>ls2</replaceable>,...)</function>
</para>
<para>
@@ -2852,8 +2852,8 @@
</para>
<para>
- The <literal>AsText()</literal> function converts a geometry
- from internal format into a WKT string.
+ The <function role="sql">AsText()</function> function
+ converts a geometry from internal format into a WKT string.
</para>
<programlisting>
@@ -2867,9 +2867,9 @@
</para>
<para>
- The <literal>AsBinary()</literal> function converts a
- geometry from internal format into a <literal>BLOB</literal>
- containing the WKB value.
+ The <function role="sql">AsBinary()</function> function
+ converts a geometry from internal format into a
+ <literal>BLOB</literal> containing the WKB value.
</para>
<programlisting>
@@ -2969,7 +2969,7 @@
<primary>AsBinary()</primary>
</indexterm>
- <literal>AsBinary(<replaceable>g</replaceable>)</literal>
+ <function role="sql">AsBinary(<replaceable>g</replaceable>)</function>
</para>
<para>
@@ -2998,7 +2998,7 @@
<primary>AsText()</primary>
</indexterm>
- <literal>AsText(<replaceable>g</replaceable>)</literal>
+ <function role="sql">AsText(<replaceable>g</replaceable>)</function>
</para>
<para>
@@ -3034,8 +3034,8 @@
Converts a string value from its WKT representation into
internal geometry format and returns the result. A number of
type-specific functions are also supported, such as
- <literal>PointFromText()</literal> and
- <literal>LineFromText()</literal>. See
+ <function role="sql">PointFromText()</function> and
+ <function role="sql">LineFromText()</function>. See
<xref linkend="gis-wkt-functions"/>.
</para>
</listitem>
@@ -3046,15 +3046,15 @@
<primary>GeomFromWKB()</primary>
</indexterm>
- <literal>GeomFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</literal>
+ <function role="sql">GeomFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</function>
</para>
<para>
Converts a binary value from its WKB representation into
internal geometry format and returns the result. A number of
type-specific functions are also supported, such as
- <literal>PointFromWKB()</literal> and
- <literal>LineFromWKB()</literal>. See
+ <function role="sql">PointFromWKB()</function> and
+ <function role="sql">LineFromWKB()</function>. See
<xref linkend="gis-wkb-functions"/>.
</para>
</listitem>
@@ -3073,9 +3073,9 @@
property of the geometry. Some functions restrict their argument
type. Such functions return <literal>NULL</literal> if the
argument is of an incorrect geometry type. For example,
- <literal>Area()</literal> returns <literal>NULL</literal> if the
- object type is neither <literal>Polygon</literal> nor
- <literal>MultiPolygon</literal>.
+ <function role="sql">Area()</function> returns
+ <literal>NULL</literal> if the object type is neither
+ <literal>Polygon</literal> nor <literal>MultiPolygon</literal>.
</para>
<section id="general-geometry-property-functions">
@@ -3101,7 +3101,7 @@
<primary>Dimension()</primary>
</indexterm>
- <literal>Dimension(<replaceable>g</replaceable>)</literal>
+ <function role="sql">Dimension(<replaceable>g</replaceable>)</function>
</para>
<para>
@@ -3135,7 +3135,7 @@
<primary>Envelope()</primary>
</indexterm>
- <literal>Envelope(<replaceable>g</replaceable>)</literal>
+ <function role="sql">Envelope(<replaceable>g</replaceable>)</function>
</para>
<para>
@@ -3177,7 +3177,7 @@
<primary>GeometryType()</primary>
</indexterm>
- <literal>GeometryType(<replaceable>g</replaceable>)</literal>
+ <function role="sql">GeometryType(<replaceable>g</replaceable>)</function>
</para>
<para>
@@ -3211,7 +3211,7 @@
<primary>SRID()</primary>
</indexterm>
- <literal>SRID(<replaceable>g</replaceable>)</literal>
+ <function role="sql">SRID(<replaceable>g</replaceable>)</function>
</para>
<para>
@@ -3258,7 +3258,7 @@
<primary>Boundary()</primary>
</indexterm>
- <literal>Boundary(<replaceable>g</replaceable>)</literal>
+ <function role="sql">Boundary(<replaceable>g</replaceable>)</function>
</para>
<para>
@@ -3280,7 +3280,7 @@
<primary>IsEmpty()</primary>
</indexterm>
- <literal>IsEmpty(<replaceable>g</replaceable>)</literal>
+ <function role="sql">IsEmpty(<replaceable>g</replaceable>)</function>
</para>
<para>
@@ -3304,7 +3304,7 @@
<primary>IsSimple()</primary>
</indexterm>
- <literal>IsSimple(<replaceable>g</replaceable>)</literal>
+ <function role="sql">IsSimple(<replaceable>g</replaceable>)</function>
</para>
<para>
@@ -3317,8 +3317,9 @@
Returns 1 if the geometry value
<replaceable>g</replaceable> has no anomalous geometric
points, such as self-intersection or self-tangency.
- <literal>IsSimple()</literal> returns 0 if the argument is
- not simple, and −1 if it is <literal>NULL</literal>.
+ <function role="sql">IsSimple()</function> returns 0 if
+ the argument is not simple, and −1 if it is
+ <literal>NULL</literal>.
</para>
<para>
@@ -3359,7 +3360,7 @@
<primary>X()</primary>
</indexterm>
- <literal>X(<replaceable>p</replaceable>)</literal>
+ <function role="sql">X(<replaceable>p</replaceable>)</function>
</para>
<para>
@@ -3392,7 +3393,7 @@
<primary>Y()</primary>
</indexterm>
- <literal>Y(<replaceable>p</replaceable>)</literal>
+ <function role="sql">Y(<replaceable>p</replaceable>)</function>
</para>
<para>
@@ -3444,7 +3445,7 @@
<primary>EndPoint()</primary>
</indexterm>
- <literal>EndPoint(<replaceable>ls</replaceable>)</literal>
+ <function role="sql">EndPoint(<replaceable>ls</replaceable>)</function>
</para>
<para>
@@ -3478,7 +3479,7 @@
<primary>GLength()</primary>
</indexterm>
- <literal>GLength(<replaceable>ls</replaceable>)</literal>
+ <function role="sql">GLength(<replaceable>ls</replaceable>)</function>
</para>
<para>
@@ -3503,9 +3504,9 @@
</programlisting>
<para>
- <literal>GLength()</literal> is a non-standard name. It
- corresponds to the OpenGIS <literal>Length()</literal>
- function.
+ <function role="sql">GLength()</function> is a
+ non-standard name. It corresponds to the OpenGIS
+ <function role="sql">Length()</function> function.
</para>
</listitem>
@@ -3519,7 +3520,7 @@
<primary>NumPoints()</primary>
</indexterm>
- <literal>NumPoints(<replaceable>ls</replaceable>)</literal>
+ <function role="sql">NumPoints(<replaceable>ls</replaceable>)</function>
</para>
<para>
@@ -3553,7 +3554,7 @@
<primary>PointN()</primary>
</indexterm>
- <literal>PointN(<replaceable>ls</replaceable>,<replaceable>N</replaceable>)</literal>
+ <function role="sql">PointN(<replaceable>ls</replaceable>,<replaceable>N</replaceable>)</function>
</para>
<para>
@@ -3628,17 +3629,18 @@
<primary>IsRing()</primary>
</indexterm>
- <literal>IsRing(<replaceable>ls</replaceable>)</literal>
+ <function role="sql">IsRing(<replaceable>ls</replaceable>)</function>
</para>
<para>
Returns 1 if the <literal>LineString</literal> value
<replaceable>ls</replaceable> is closed (that is, its
<function role="sql">StartPoint()</function> and
- <literal>EndPoint()</literal> values are the same) and is
- simple (does not pass through the same point more than
- once). Returns 0 if <replaceable>ls</replaceable> is not a
- ring, and −1 if it is <literal>NULL</literal>.
+ <function role="sql">EndPoint()</function> values are the
+ same) and is simple (does not pass through the same point
+ more than once). Returns 0 if
+ <replaceable>ls</replaceable> is not a ring, and −1
+ if it is <literal>NULL</literal>.
</para>
</listitem>
@@ -3668,7 +3670,7 @@
<primary>GLength()</primary>
</indexterm>
- <literal>GLength(<replaceable>mls</replaceable>)</literal>
+ <function role="sql">GLength(<replaceable>mls</replaceable>)</function>
</para>
<para>
@@ -3690,9 +3692,9 @@
</programlisting>
<para>
- <literal>GLength()</literal> is a non-standard name. It
- corresponds to the OpenGIS <literal>Length()</literal>
- function.
+ <function role="sql">GLength()</function> is a
+ non-standard name. It corresponds to the OpenGIS
+ <function role="sql">Length()</function> function.
</para>
</listitem>
@@ -3702,15 +3704,15 @@
<primary>IsClosed()</primary>
</indexterm>
- <literal>IsClosed(<replaceable>mls</replaceable>)</literal>
+ <function role="sql">IsClosed(<replaceable>mls</replaceable>)</function>
</para>
<para>
Returns 1 if the <literal>MultiLineString</literal> value
<replaceable>mls</replaceable> is closed (that is, the
<function role="sql">StartPoint()</function> and
- <literal>EndPoint()</literal> values are the same for each
- <literal>LineString</literal> in
+ <function role="sql">EndPoint()</function> values are the
+ same for each <literal>LineString</literal> in
<replaceable>mls</replaceable>). Returns 0 if
<replaceable>mls</replaceable> is not closed, and −1
if it is <literal>NULL</literal>.
@@ -3753,7 +3755,7 @@
<primary>Area()</primary>
</indexterm>
- <literal>Area(<replaceable>poly</replaceable>)</literal>
+ <function role="sql">Area(<replaceable>poly</replaceable>)</function>
</para>
<para>
@@ -3788,7 +3790,7 @@
<primary>ExteriorRing()</primary>
</indexterm>
- <literal>ExteriorRing(<replaceable>poly</replaceable>)</literal>
+ <function role="sql">ExteriorRing(<replaceable>poly</replaceable>)</function>
</para>
<para>
@@ -3824,7 +3826,7 @@
<primary>InteriorRingN()</primary>
</indexterm>
- <literal>InteriorRingN(<replaceable>poly</replaceable>,<replaceable>N</replaceable>)</literal>
+ <function role="sql">InteriorRingN(<replaceable>poly</replaceable>,<replaceable>N</replaceable>)</function>
</para>
<para>
@@ -3861,7 +3863,7 @@
<primary>NumInteriorRings()</primary>
</indexterm>
- <literal>NumInteriorRings(<replaceable>poly</replaceable>)</literal>
+ <function role="sql">NumInteriorRings(<replaceable>poly</replaceable>)</function>
</para>
<para>
@@ -3906,7 +3908,7 @@
<primary>Area()</primary>
</indexterm>
- <literal>Area(<replaceable>mpoly</replaceable>)</literal>
+ <function role="sql">Area(<replaceable>mpoly</replaceable>)</function>
</para>
<para>
@@ -3943,7 +3945,7 @@
<primary>Centroid()</primary>
</indexterm>
- <literal>Centroid(<replaceable>mpoly</replaceable>)</literal>
+ <function role="sql">Centroid(<replaceable>mpoly</replaceable>)</function>
</para>
<para>
@@ -3997,7 +3999,7 @@
<primary>GeometryN()</primary>
</indexterm>
- <literal>GeometryN(<replaceable>gc</replaceable>,<replaceable>N</replaceable>)</literal>
+ <function role="sql">GeometryN(<replaceable>gc</replaceable>,<replaceable>N</replaceable>)</function>
</para>
<para>
@@ -4032,7 +4034,7 @@
<primary>NumGeometries()</primary>
</indexterm>
- <literal>NumGeometries(<replaceable>gc</replaceable>)</literal>
+ <function role="sql">NumGeometries(<replaceable>gc</replaceable>)</function>
</para>
<para>
@@ -4155,7 +4157,7 @@
<primary>Buffer()</primary>
</indexterm>
- <literal>Buffer(<replaceable>g</replaceable>,<replaceable>d</replaceable>)</literal>
+ <function role="sql">Buffer(<replaceable>g</replaceable>,<replaceable>d</replaceable>)</function>
</para>
<para>
@@ -4177,7 +4179,7 @@
<primary>ConvexHull()</primary>
</indexterm>
- <literal>ConvexHull(<replaceable>g</replaceable>)</literal>
+ <function role="sql">ConvexHull(<replaceable>g</replaceable>)</function>
</para>
<para>
@@ -4197,7 +4199,7 @@
<primary>Difference()</primary>
</indexterm>
- <literal>Difference(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">Difference(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4219,7 +4221,7 @@
<primary>Intersection()</primary>
</indexterm>
- <literal>Intersection(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">Intersection(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4241,7 +4243,7 @@
<primary>SymDifference()</primary>
</indexterm>
- <literal>SymDifference(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">SymDifference(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4263,7 +4265,7 @@
<primary>Union()</primary>
</indexterm>
- <literal>Union(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">Union(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4324,7 +4326,7 @@
<primary>MBRContains()</primary>
</indexterm>
- <literal>MBRContains(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">MBRContains(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4332,7 +4334,7 @@
Rectangle of <replaceable>g1</replaceable> contains the
Minimum Bounding Rectangle of <replaceable>g2</replaceable>.
This tests the opposite relationship as
- <literal>MBRWithin()</literal>.
+ <function role="sql">MBRWithin()</function>.
</para>
<remark role="help-description-end"/>
@@ -4361,7 +4363,7 @@
<primary>MBRDisjoint()</primary>
</indexterm>
- <literal>MBRDisjoint(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">MBRDisjoint(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4385,7 +4387,7 @@
<primary>MBREqual()</primary>
</indexterm>
- <literal>MBREqual(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">MBREqual(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4408,7 +4410,7 @@
<primary>MBRIntersects()</primary>
</indexterm>
- <literal>MBRIntersects(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">MBRIntersects(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4431,7 +4433,7 @@
<primary>MBROverlaps()</primary>
</indexterm>
- <literal>MBROverlaps(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">MBROverlaps(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4458,7 +4460,7 @@
<primary>MBRTouches()</primary>
</indexterm>
- <literal>MBRTouches(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">MBRTouches(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4485,7 +4487,7 @@
<primary>MBRWithin()</primary>
</indexterm>
- <literal>MBRWithin(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">MBRWithin(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4493,7 +4495,7 @@
Rectangle of <replaceable>g1</replaceable> is within the
Minimum Bounding Rectangle of <replaceable>g2</replaceable>.
This tests the opposite relationship as
- <literal>MBRContains()</literal>.
+ <function role="sql">MBRContains()</function>.
</para>
<remark role="help-description-end"/>
@@ -4536,8 +4538,8 @@
to the specification. Those that are implemented return the
same result as the corresponding MBR-based functions. This
includes functions in the following list other than
- <literal>Distance()</literal> and
- <literal>Related()</literal>.
+ <function role="sql">Distance()</function> and
+ <function role="sql">Related()</function>.
</para>
<remark role="note">
@@ -4565,14 +4567,14 @@
<primary>Contains()</primary>
</indexterm>
- <literal>Contains(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">Contains(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
Returns 1 or 0 to indicate whether
<replaceable>g1</replaceable> completely contains
<replaceable>g2</replaceable>. This tests the opposite
- relationship as <literal>Within()</literal>.
+ relationship as <function role="sql">Within()</function>.
</para>
<remark role="help-description-end"/>
@@ -4588,7 +4590,7 @@
<primary>Crosses()</primary>
</indexterm>
- <literal>Crosses(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">Crosses(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4645,7 +4647,7 @@
<primary>Disjoint()</primary>
</indexterm>
- <literal>Disjoint(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">Disjoint(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4668,7 +4670,7 @@
<primary>Distance()</primary>
</indexterm>
- <literal>Distance(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">Distance(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4687,7 +4689,7 @@
<primary>Equals()</primary>
</indexterm>
- <literal>Equals(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">Equals(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4709,7 +4711,7 @@
<primary>Intersects()</primary>
</indexterm>
- <literal>Intersects(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">Intersects(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4731,7 +4733,7 @@
<primary>Overlaps()</primary>
</indexterm>
- <literal>Overlaps(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">Overlaps(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4781,7 +4783,7 @@
<primary>Touches()</primary>
</indexterm>
- <literal>Touches(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">Touches(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4807,14 +4809,14 @@
<primary>Within()</primary>
</indexterm>
- <literal>Within(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">Within(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
Returns 1 or 0 to indicate whether
<replaceable>g1</replaceable> is spatially within
<replaceable>g2</replaceable>. This tests the opposite
- relationship as <literal>Contains()</literal>.
+ relationship as <function role="sql">Contains()</function>.
</para>
<remark role="help-description-end"/>
@@ -5030,10 +5032,10 @@
<para>
The optimizer investigates whether available spatial indexes can
be involved in the search for queries that use a function such
- as <literal>MBRContains()</literal> or
- <literal>MBRWithin()</literal> in the <literal>WHERE</literal>
- clause. The following query finds all objects that are in the
- given rectangle:
+ as <function role="sql">MBRContains()</function> or
+ <function role="sql">MBRWithin()</function> in the
+ <literal>WHERE</literal> clause. The following query finds all
+ objects that are in the given rectangle:
</para>
<programlisting>
@@ -5218,19 +5220,19 @@
<listitem>
<para>
- The OpenGIS function <literal>Length()</literal> on
- <literal>LineString</literal> and
+ The OpenGIS function <function role="sql">Length()</function>
+ on <literal>LineString</literal> and
<literal>MultiLineString</literal> currently should be called
- in MySQL as <literal>GLength()</literal>
+ in MySQL as <function role="sql">GLength()</function>
</para>
<para>
The problem is that there is an existing SQL function
- <literal>Length()</literal> that calculates the length of
- string values, and sometimes it is not possible to distinguish
- whether the function is called in a textual or spatial
- context. We need either to solve this somehow, or decide on
- another function name.
+ <function role="sql">Length()</function> that calculates the
+ length of string values, and sometimes it is not possible to
+ distinguish whether the function is called in a textual or
+ spatial context. We need either to solve this somehow, or
+ decide on another function name.
</para>
</listitem>
Modified: trunk/refman-6.0/spatial-extensions.xml
===================================================================
--- trunk/refman-6.0/spatial-extensions.xml 2008-01-26 00:31:52 UTC (rev 9640)
+++ trunk/refman-6.0/spatial-extensions.xml 2008-01-26 00:32:49 UTC (rev 9641)
Changed blocks: 89, Lines Added: 139, Lines Deleted: 137; 39651 bytes
@@ -1927,8 +1927,8 @@
<primary>LineStringFromText()</primary>
</indexterm>
- <literal>LineFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</literal>,
- <literal>LineStringFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</literal>
+ <function role="sql">LineFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</function>,
+ <function role="sql" condition="linefromtext">LineStringFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</function>
</para>
<para>
@@ -1957,8 +1957,8 @@
<primary>MultiLineStringFromText()</primary>
</indexterm>
- <literal>MLineFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</literal>,
- <literal>MultiLineStringFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</literal>
+ <function role="sql">MLineFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</function>,
+ <function role="sql" condition="mlinefromtext">MultiLineStringFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</function>
</para>
<para>
@@ -1987,8 +1987,8 @@
<primary>MultiPointFromText()</primary>
</indexterm>
- <literal>MPointFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</literal>,
- <literal>MultiPointFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</literal>
+ <function role="sql">MPointFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</function>,
+ <function role="sql" condition="mpointfromtext">MultiPointFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</function>
</para>
<para>
@@ -2017,8 +2017,8 @@
<primary>MultiPolygonFromText()</primary>
</indexterm>
- <literal>MPolyFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</literal>,
- <literal>MultiPolygonFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</literal>
+ <function role="sql">MPolyFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</function>,
+ <function role="sql" condition="mpolyfromtext">MultiPolygonFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</function>
</para>
<para>
@@ -2039,7 +2039,7 @@
<primary>PointFromText()</primary>
</indexterm>
- <literal>PointFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</literal>
+ <function role="sql">PointFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</function>
</para>
<para>
@@ -2068,8 +2068,8 @@
<primary>PolygonFromText()</primary>
</indexterm>
- <literal>PolyFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</literal>,
- <literal>PolygonFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</literal>
+ <function role="sql">PolyFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</function>,
+ <function role="sql" condition="polyfromtext">PolygonFromText(<replaceable>wkt</replaceable>[,<replaceable>srid</replaceable>])</function>
</para>
<para>
@@ -2100,7 +2100,7 @@
<primary>BdMPolyFromText()</primary>
</indexterm>
- <literal>BdMPolyFromText(<replaceable>wkt</replaceable>,<replaceable>srid</replaceable>)</literal>
+ <function role="sql">BdMPolyFromText(<replaceable>wkt</replaceable>,<replaceable>srid</replaceable>)</function>
</para>
<para>
@@ -2117,7 +2117,7 @@
<primary>BdPolyFromText()</primary>
</indexterm>
- <literal>BdPolyFromText(<replaceable>wkt</replaceable>,<replaceable>srid</replaceable>)</literal>
+ <function role="sql">BdPolyFromText(<replaceable>wkt</replaceable>,<replaceable>srid</replaceable>)</function>
</para>
<para>
@@ -2145,10 +2145,10 @@
</para>
<para>
- <literal>GeomFromWKB()</literal> accepts a WKB of any geometry
- type as its first argument. An implementation also provides
- type-specific construction functions for construction of
- geometry values of each geometry type.
+ <function role="sql">GeomFromWKB()</function> accepts a WKB of
+ any geometry type as its first argument. An implementation
+ also provides type-specific construction functions for
+ construction of geometry values of each geometry type.
</para>
<remark role="help-category" condition="WKB@Geographic Features"/>
@@ -2173,8 +2173,8 @@
<primary>GeometryCollectionFromWKB()</primary>
</indexterm>
- <literal>GeomCollFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</literal>,
- <literal>GeometryCollectionFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</literal>
+ <function role="sql">GeomCollFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</function>,
+ <function role="sql" condition="geomcollfromwkb">GeometryCollectionFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</function>
</para>
<para>
@@ -2203,8 +2203,8 @@
<primary>GeometryFromWKB()</primary>
</indexterm>
- <literal>GeomFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</literal>,
- <literal>GeometryFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</literal>
+ <function role="sql">GeomFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</function>,
+ <function role="sql" condition="geomfromwkb">GeometryFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</function>
</para>
<para>
@@ -2233,8 +2233,8 @@
<primary>LineStringFromWKB()</primary>
</indexterm>
- <literal>LineFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</literal>,
- <literal>LineStringFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</literal>
+ <function role="sql">LineFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</function>,
+ <function role="sql" condition="linefromwkb">LineStringFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</function>
</para>
<para>
@@ -2263,8 +2263,8 @@
<primary>MultiLineStringFromWKB()</primary>
</indexterm>
- <literal>MLineFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</literal>,
- <literal>MultiLineStringFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</literal>
+ <function role="sql">MLineFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</function>,
+ <function role="sql" condition="mlinefromwkb">MultiLineStringFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</function>
</para>
<para>
@@ -2293,8 +2293,8 @@
<primary>MultiPointFromWKB()</primary>
</indexterm>
- <literal>MPointFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</literal>,
- <literal>MultiPointFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</literal>
+ <function role="sql">MPointFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</function>,
+ <function role="sql" condition="mpointfromwkb">MultiPointFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</function>
</para>
<para>
@@ -2314,7 +2314,7 @@
<remark role="help-description-begin"/>
- <para id="function_mpolyfromwbk">
+ <para id="function_mpolyfromwkb">
<indexterm>
<primary>MPolyFromWKB()</primary>
</indexterm>
@@ -2323,8 +2323,8 @@
<primary>MultiPolygonFromWKB()</primary>
</indexterm>
- <literal>MPolyFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</literal>,
- <literal>MultiPolygonFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</literal>
+ <function role="sql">MPolyFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</function>,
+ <function role="sql" condition="mpolyfromwkb">MultiPolygonFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</function>
</para>
<para>
@@ -2349,7 +2349,7 @@
<primary>PointFromWKB()</primary>
</indexterm>
- <literal>PointFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</literal>
+ <function role="sql">PointFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</function>
</para>
<para>
@@ -2378,8 +2378,8 @@
<primary>PolygonFromWKB()</primary>
</indexterm>
- <literal>PolyFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</literal>,
- <literal>PolygonFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</literal>
+ <function role="sql">PolyFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</function>,
+ <function role="sql" condition="polyfromwkb">PolygonFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</function>
</para>
<para>
@@ -2409,7 +2409,7 @@
<primary>BdMPolyFromWKB()</primary>
</indexterm>
- <literal>BdMPolyFromWKB(<replaceable>wkb</replaceable>,<replaceable>srid</replaceable>)</literal>
+ <function role="sql">BdMPolyFromWKB(<replaceable>wkb</replaceable>,<replaceable>srid</replaceable>)</function>
</para>
<para>
@@ -2426,7 +2426,7 @@
<primary>BdPolyFromWKB()</primary>
</indexterm>
- <literal>BdPolyFromWKB(<replaceable>wkb</replaceable>,<replaceable>srid</replaceable>)</literal>
+ <function role="sql">BdPolyFromWKB(<replaceable>wkb</replaceable>,<replaceable>srid</replaceable>)</function>
</para>
<para>
@@ -2453,8 +2453,8 @@
<literal>BLOB</literal> values containing WKB representations
of geometry values with no SRID. The results of these
functions can be substituted as the first argument for any
- function in the <literal>GeomFromWKB()</literal> function
- family.
+ function in the <function role="sql">GeomFromWKB()</function>
+ function family.
</para>
<remark role="help-category" condition="Geometry constructors@Geographic Features"/>
@@ -2471,7 +2471,7 @@
<primary>GeometryCollection()</primary>
</indexterm>
- <literal>GeometryCollection(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>,...)</literal>
+ <function role="sql">GeometryCollection(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>,...)</function>
</para>
<para>
@@ -2493,7 +2493,7 @@
<primary>LineString()</primary>
</indexterm>
- <literal>LineString(<replaceable>pt1</replaceable>,<replaceable>pt2</replaceable>,...)</literal>
+ <function role="sql">LineString(<replaceable>pt1</replaceable>,<replaceable>pt2</replaceable>,...)</function>
</para>
<para>
@@ -2518,7 +2518,7 @@
<primary>MultiLineString()</primary>
</indexterm>
- <literal>MultiLineString(<replaceable>ls1</replaceable>,<replaceable>ls2</replaceable>,...)</literal>
+ <function role="sql">MultiLineString(<replaceable>ls1</replaceable>,<replaceable>ls2</replaceable>,...)</function>
</para>
<para>
@@ -2541,7 +2541,7 @@
<primary>MultiPoint()</primary>
</indexterm>
- <literal>MultiPoint(<replaceable>pt1</replaceable>,<replaceable>pt2</replaceable>,...)</literal>
+ <function role="sql">MultiPoint(<replaceable>pt1</replaceable>,<replaceable>pt2</replaceable>,...)</function>
</para>
<para>
@@ -2564,7 +2564,7 @@
<primary>MultiPolygon()</primary>
</indexterm>
- <literal>MultiPolygon(<replaceable>poly1</replaceable>,<replaceable>poly2</replaceable>,...)</literal>
+ <function role="sql">MultiPolygon(<replaceable>poly1</replaceable>,<replaceable>poly2</replaceable>,...)</function>
</para>
<para>
@@ -2587,7 +2587,7 @@
<primary>Point()</primary>
</indexterm>
- <literal>Point(<replaceable>x</replaceable>,<replaceable>y</replaceable>)</literal>
+ <function role="sql">Point(<replaceable>x</replaceable>,<replaceable>y</replaceable>)</function>
</para>
<para>
@@ -2608,7 +2608,7 @@
<primary>Polygon()</primary>
</indexterm>
- <literal>Polygon(<replaceable>ls1</replaceable>,<replaceable>ls2</replaceable>,...)</literal>
+ <function role="sql">Polygon(<replaceable>ls1</replaceable>,<replaceable>ls2</replaceable>,...)</function>
</para>
<para>
@@ -2852,8 +2852,8 @@
</para>
<para>
- The <literal>AsText()</literal> function converts a geometry
- from internal format into a WKT string.
+ The <function role="sql">AsText()</function> function
+ converts a geometry from internal format into a WKT string.
</para>
<programlisting>
@@ -2867,9 +2867,9 @@
</para>
<para>
- The <literal>AsBinary()</literal> function converts a
- geometry from internal format into a <literal>BLOB</literal>
- containing the WKB value.
+ The <function role="sql">AsBinary()</function> function
+ converts a geometry from internal format into a
+ <literal>BLOB</literal> containing the WKB value.
</para>
<programlisting>
@@ -2969,7 +2969,7 @@
<primary>AsBinary()</primary>
</indexterm>
- <literal>AsBinary(<replaceable>g</replaceable>)</literal>
+ <function role="sql">AsBinary(<replaceable>g</replaceable>)</function>
</para>
<para>
@@ -2998,7 +2998,7 @@
<primary>AsText()</primary>
</indexterm>
- <literal>AsText(<replaceable>g</replaceable>)</literal>
+ <function role="sql">AsText(<replaceable>g</replaceable>)</function>
</para>
<para>
@@ -3034,8 +3034,8 @@
Converts a string value from its WKT representation into
internal geometry format and returns the result. A number of
type-specific functions are also supported, such as
- <literal>PointFromText()</literal> and
- <literal>LineFromText()</literal>. See
+ <function role="sql">PointFromText()</function> and
+ <function role="sql">LineFromText()</function>. See
<xref linkend="gis-wkt-functions"/>.
</para>
</listitem>
@@ -3046,15 +3046,15 @@
<primary>GeomFromWKB()</primary>
</indexterm>
- <literal>GeomFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</literal>
+ <function role="sql">GeomFromWKB(<replaceable>wkb</replaceable>[,<replaceable>srid</replaceable>])</function>
</para>
<para>
Converts a binary value from its WKB representation into
internal geometry format and returns the result. A number of
type-specific functions are also supported, such as
- <literal>PointFromWKB()</literal> and
- <literal>LineFromWKB()</literal>. See
+ <function role="sql">PointFromWKB()</function> and
+ <function role="sql">LineFromWKB()</function>. See
<xref linkend="gis-wkb-functions"/>.
</para>
</listitem>
@@ -3073,9 +3073,9 @@
property of the geometry. Some functions restrict their argument
type. Such functions return <literal>NULL</literal> if the
argument is of an incorrect geometry type. For example,
- <literal>Area()</literal> returns <literal>NULL</literal> if the
- object type is neither <literal>Polygon</literal> nor
- <literal>MultiPolygon</literal>.
+ <function role="sql">Area()</function> returns
+ <literal>NULL</literal> if the object type is neither
+ <literal>Polygon</literal> nor <literal>MultiPolygon</literal>.
</para>
<section id="general-geometry-property-functions">
@@ -3101,7 +3101,7 @@
<primary>Dimension()</primary>
</indexterm>
- <literal>Dimension(<replaceable>g</replaceable>)</literal>
+ <function role="sql">Dimension(<replaceable>g</replaceable>)</function>
</para>
<para>
@@ -3135,7 +3135,7 @@
<primary>Envelope()</primary>
</indexterm>
- <literal>Envelope(<replaceable>g</replaceable>)</literal>
+ <function role="sql">Envelope(<replaceable>g</replaceable>)</function>
</para>
<para>
@@ -3177,7 +3177,7 @@
<primary>GeometryType()</primary>
</indexterm>
- <literal>GeometryType(<replaceable>g</replaceable>)</literal>
+ <function role="sql">GeometryType(<replaceable>g</replaceable>)</function>
</para>
<para>
@@ -3211,7 +3211,7 @@
<primary>SRID()</primary>
</indexterm>
- <literal>SRID(<replaceable>g</replaceable>)</literal>
+ <function role="sql">SRID(<replaceable>g</replaceable>)</function>
</para>
<para>
@@ -3258,7 +3258,7 @@
<primary>Boundary()</primary>
</indexterm>
- <literal>Boundary(<replaceable>g</replaceable>)</literal>
+ <function role="sql">Boundary(<replaceable>g</replaceable>)</function>
</para>
<para>
@@ -3280,7 +3280,7 @@
<primary>IsEmpty()</primary>
</indexterm>
- <literal>IsEmpty(<replaceable>g</replaceable>)</literal>
+ <function role="sql">IsEmpty(<replaceable>g</replaceable>)</function>
</para>
<para>
@@ -3304,7 +3304,7 @@
<primary>IsSimple()</primary>
</indexterm>
- <literal>IsSimple(<replaceable>g</replaceable>)</literal>
+ <function role="sql">IsSimple(<replaceable>g</replaceable>)</function>
</para>
<para>
@@ -3317,8 +3317,9 @@
Returns 1 if the geometry value
<replaceable>g</replaceable> has no anomalous geometric
points, such as self-intersection or self-tangency.
- <literal>IsSimple()</literal> returns 0 if the argument is
- not simple, and −1 if it is <literal>NULL</literal>.
+ <function role="sql">IsSimple()</function> returns 0 if
+ the argument is not simple, and −1 if it is
+ <literal>NULL</literal>.
</para>
<para>
@@ -3359,7 +3360,7 @@
<primary>X()</primary>
</indexterm>
- <literal>X(<replaceable>p</replaceable>)</literal>
+ <function role="sql">X(<replaceable>p</replaceable>)</function>
</para>
<para>
@@ -3392,7 +3393,7 @@
<primary>Y()</primary>
</indexterm>
- <literal>Y(<replaceable>p</replaceable>)</literal>
+ <function role="sql">Y(<replaceable>p</replaceable>)</function>
</para>
<para>
@@ -3444,7 +3445,7 @@
<primary>EndPoint()</primary>
</indexterm>
- <literal>EndPoint(<replaceable>ls</replaceable>)</literal>
+ <function role="sql">EndPoint(<replaceable>ls</replaceable>)</function>
</para>
<para>
@@ -3478,7 +3479,7 @@
<primary>GLength()</primary>
</indexterm>
- <literal>GLength(<replaceable>ls</replaceable>)</literal>
+ <function role="sql">GLength(<replaceable>ls</replaceable>)</function>
</para>
<para>
@@ -3503,9 +3504,9 @@
</programlisting>
<para>
- <literal>GLength()</literal> is a non-standard name. It
- corresponds to the OpenGIS <literal>Length()</literal>
- function.
+ <function role="sql">GLength()</function> is a
+ non-standard name. It corresponds to the OpenGIS
+ <function role="sql">Length()</function> function.
</para>
</listitem>
@@ -3519,7 +3520,7 @@
<primary>NumPoints()</primary>
</indexterm>
- <literal>NumPoints(<replaceable>ls</replaceable>)</literal>
+ <function role="sql">NumPoints(<replaceable>ls</replaceable>)</function>
</para>
<para>
@@ -3553,7 +3554,7 @@
<primary>PointN()</primary>
</indexterm>
- <literal>PointN(<replaceable>ls</replaceable>,<replaceable>N</replaceable>)</literal>
+ <function role="sql">PointN(<replaceable>ls</replaceable>,<replaceable>N</replaceable>)</function>
</para>
<para>
@@ -3628,17 +3629,18 @@
<primary>IsRing()</primary>
</indexterm>
- <literal>IsRing(<replaceable>ls</replaceable>)</literal>
+ <function role="sql">IsRing(<replaceable>ls</replaceable>)</function>
</para>
<para>
Returns 1 if the <literal>LineString</literal> value
<replaceable>ls</replaceable> is closed (that is, its
<function role="sql">StartPoint()</function> and
- <literal>EndPoint()</literal> values are the same) and is
- simple (does not pass through the same point more than
- once). Returns 0 if <replaceable>ls</replaceable> is not a
- ring, and −1 if it is <literal>NULL</literal>.
+ <function role="sql">EndPoint()</function> values are the
+ same) and is simple (does not pass through the same point
+ more than once). Returns 0 if
+ <replaceable>ls</replaceable> is not a ring, and −1
+ if it is <literal>NULL</literal>.
</para>
</listitem>
@@ -3668,7 +3670,7 @@
<primary>GLength()</primary>
</indexterm>
- <literal>GLength(<replaceable>mls</replaceable>)</literal>
+ <function role="sql">GLength(<replaceable>mls</replaceable>)</function>
</para>
<para>
@@ -3690,9 +3692,9 @@
</programlisting>
<para>
- <literal>GLength()</literal> is a non-standard name. It
- corresponds to the OpenGIS <literal>Length()</literal>
- function.
+ <function role="sql">GLength()</function> is a
+ non-standard name. It corresponds to the OpenGIS
+ <function role="sql">Length()</function> function.
</para>
</listitem>
@@ -3702,15 +3704,15 @@
<primary>IsClosed()</primary>
</indexterm>
- <literal>IsClosed(<replaceable>mls</replaceable>)</literal>
+ <function role="sql">IsClosed(<replaceable>mls</replaceable>)</function>
</para>
<para>
Returns 1 if the <literal>MultiLineString</literal> value
<replaceable>mls</replaceable> is closed (that is, the
<function role="sql">StartPoint()</function> and
- <literal>EndPoint()</literal> values are the same for each
- <literal>LineString</literal> in
+ <function role="sql">EndPoint()</function> values are the
+ same for each <literal>LineString</literal> in
<replaceable>mls</replaceable>). Returns 0 if
<replaceable>mls</replaceable> is not closed, and −1
if it is <literal>NULL</literal>.
@@ -3753,7 +3755,7 @@
<primary>Area()</primary>
</indexterm>
- <literal>Area(<replaceable>poly</replaceable>)</literal>
+ <function role="sql">Area(<replaceable>poly</replaceable>)</function>
</para>
<para>
@@ -3788,7 +3790,7 @@
<primary>ExteriorRing()</primary>
</indexterm>
- <literal>ExteriorRing(<replaceable>poly</replaceable>)</literal>
+ <function role="sql">ExteriorRing(<replaceable>poly</replaceable>)</function>
</para>
<para>
@@ -3824,7 +3826,7 @@
<primary>InteriorRingN()</primary>
</indexterm>
- <literal>InteriorRingN(<replaceable>poly</replaceable>,<replaceable>N</replaceable>)</literal>
+ <function role="sql">InteriorRingN(<replaceable>poly</replaceable>,<replaceable>N</replaceable>)</function>
</para>
<para>
@@ -3861,7 +3863,7 @@
<primary>NumInteriorRings()</primary>
</indexterm>
- <literal>NumInteriorRings(<replaceable>poly</replaceable>)</literal>
+ <function role="sql">NumInteriorRings(<replaceable>poly</replaceable>)</function>
</para>
<para>
@@ -3906,7 +3908,7 @@
<primary>Area()</primary>
</indexterm>
- <literal>Area(<replaceable>mpoly</replaceable>)</literal>
+ <function role="sql">Area(<replaceable>mpoly</replaceable>)</function>
</para>
<para>
@@ -3943,7 +3945,7 @@
<primary>Centroid()</primary>
</indexterm>
- <literal>Centroid(<replaceable>mpoly</replaceable>)</literal>
+ <function role="sql">Centroid(<replaceable>mpoly</replaceable>)</function>
</para>
<para>
@@ -3997,7 +3999,7 @@
<primary>GeometryN()</primary>
</indexterm>
- <literal>GeometryN(<replaceable>gc</replaceable>,<replaceable>N</replaceable>)</literal>
+ <function role="sql">GeometryN(<replaceable>gc</replaceable>,<replaceable>N</replaceable>)</function>
</para>
<para>
@@ -4032,7 +4034,7 @@
<primary>NumGeometries()</primary>
</indexterm>
- <literal>NumGeometries(<replaceable>gc</replaceable>)</literal>
+ <function role="sql">NumGeometries(<replaceable>gc</replaceable>)</function>
</para>
<para>
@@ -4155,7 +4157,7 @@
<primary>Buffer()</primary>
</indexterm>
- <literal>Buffer(<replaceable>g</replaceable>,<replaceable>d</replaceable>)</literal>
+ <function role="sql">Buffer(<replaceable>g</replaceable>,<replaceable>d</replaceable>)</function>
</para>
<para>
@@ -4177,7 +4179,7 @@
<primary>ConvexHull()</primary>
</indexterm>
- <literal>ConvexHull(<replaceable>g</replaceable>)</literal>
+ <function role="sql">ConvexHull(<replaceable>g</replaceable>)</function>
</para>
<para>
@@ -4197,7 +4199,7 @@
<primary>Difference()</primary>
</indexterm>
- <literal>Difference(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">Difference(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4219,7 +4221,7 @@
<primary>Intersection()</primary>
</indexterm>
- <literal>Intersection(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">Intersection(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4241,7 +4243,7 @@
<primary>SymDifference()</primary>
</indexterm>
- <literal>SymDifference(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">SymDifference(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4263,7 +4265,7 @@
<primary>Union()</primary>
</indexterm>
- <literal>Union(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">Union(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4324,7 +4326,7 @@
<primary>MBRContains()</primary>
</indexterm>
- <literal>MBRContains(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">MBRContains(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4332,7 +4334,7 @@
Rectangle of <replaceable>g1</replaceable> contains the
Minimum Bounding Rectangle of <replaceable>g2</replaceable>.
This tests the opposite relationship as
- <literal>MBRWithin()</literal>.
+ <function role="sql">MBRWithin()</function>.
</para>
<remark role="help-description-end"/>
@@ -4361,7 +4363,7 @@
<primary>MBRDisjoint()</primary>
</indexterm>
- <literal>MBRDisjoint(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">MBRDisjoint(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4385,7 +4387,7 @@
<primary>MBREqual()</primary>
</indexterm>
- <literal>MBREqual(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">MBREqual(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4408,7 +4410,7 @@
<primary>MBRIntersects()</primary>
</indexterm>
- <literal>MBRIntersects(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">MBRIntersects(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4431,7 +4433,7 @@
<primary>MBROverlaps()</primary>
</indexterm>
- <literal>MBROverlaps(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">MBROverlaps(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4458,7 +4460,7 @@
<primary>MBRTouches()</primary>
</indexterm>
- <literal>MBRTouches(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">MBRTouches(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4485,7 +4487,7 @@
<primary>MBRWithin()</primary>
</indexterm>
- <literal>MBRWithin(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">MBRWithin(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4493,7 +4495,7 @@
Rectangle of <replaceable>g1</replaceable> is within the
Minimum Bounding Rectangle of <replaceable>g2</replaceable>.
This tests the opposite relationship as
- <literal>MBRContains()</literal>.
+ <function role="sql">MBRContains()</function>.
</para>
<remark role="help-description-end"/>
@@ -4536,8 +4538,8 @@
to the specification. Those that are implemented return the
same result as the corresponding MBR-based functions. This
includes functions in the following list other than
- <literal>Distance()</literal> and
- <literal>Related()</literal>.
+ <function role="sql">Distance()</function> and
+ <function role="sql">Related()</function>.
</para>
<remark role="note">
@@ -4565,14 +4567,14 @@
<primary>Contains()</primary>
</indexterm>
- <literal>Contains(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">Contains(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
Returns 1 or 0 to indicate whether
<replaceable>g1</replaceable> completely contains
<replaceable>g2</replaceable>. This tests the opposite
- relationship as <literal>Within()</literal>.
+ relationship as <function role="sql">Within()</function>.
</para>
<remark role="help-description-end"/>
@@ -4588,7 +4590,7 @@
<primary>Crosses()</primary>
</indexterm>
- <literal>Crosses(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">Crosses(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4645,7 +4647,7 @@
<primary>Disjoint()</primary>
</indexterm>
- <literal>Disjoint(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">Disjoint(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4668,7 +4670,7 @@
<primary>Distance()</primary>
</indexterm>
- <literal>Distance(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">Distance(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4687,7 +4689,7 @@
<primary>Equals()</primary>
</indexterm>
- <literal>Equals(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">Equals(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4709,7 +4711,7 @@
<primary>Intersects()</primary>
</indexterm>
- <literal>Intersects(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">Intersects(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4731,7 +4733,7 @@
<primary>Overlaps()</primary>
</indexterm>
- <literal>Overlaps(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">Overlaps(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4781,7 +4783,7 @@
<primary>Touches()</primary>
</indexterm>
- <literal>Touches(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">Touches(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
@@ -4807,14 +4809,14 @@
<primary>Within()</primary>
</indexterm>
- <literal>Within(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</literal>
+ <function role="sql">Within(<replaceable>g1</replaceable>,<replaceable>g2</replaceable>)</function>
</para>
<para>
Returns 1 or 0 to indicate whether
<replaceable>g1</replaceable> is spatially within
<replaceable>g2</replaceable>. This tests the opposite
- relationship as <literal>Contains()</literal>.
+ relationship as <function role="sql">Contains()</function>.
</para>
<remark role="help-description-end"/>
@@ -5030,10 +5032,10 @@
<para>
The optimizer investigates whether available spatial indexes can
be involved in the search for queries that use a function such
- as <literal>MBRContains()</literal> or
- <literal>MBRWithin()</literal> in the <literal>WHERE</literal>
- clause. The following query finds all objects that are in the
- given rectangle:
+ as <function role="sql">MBRContains()</function> or
+ <function role="sql">MBRWithin()</function> in the
+ <literal>WHERE</literal> clause. The following query finds all
+ objects that are in the given rectangle:
</para>
<programlisting>
@@ -5218,19 +5220,19 @@
<listitem>
<para>
- The OpenGIS function <literal>Length()</literal> on
- <literal>LineString</literal> and
+ The OpenGIS function <function role="sql">Length()</function>
+ on <literal>LineString</literal> and
<literal>MultiLineString</literal> currently should be called
- in MySQL as <literal>GLength()</literal>
+ in MySQL as <function role="sql">GLength()</function>
</para>
<para>
The problem is that there is an existing SQL function
- <literal>Length()</literal> that calculates the length of
- string values, and sometimes it is not possible to distinguish
- whether the function is called in a textual or spatial
- context. We need either to solve this somehow, or decide on
- another function name.
+ <function role="sql">Length()</function> that calculates the
+ length of string values, and sometimes it is not possible to
+ distinguish whether the function is called in a textual or
+ spatial context. We need either to solve this somehow, or
+ decide on another function name.
</para>
</listitem>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r9641 - in trunk: . refman-4.1 refman-5.0 refman-5.1 refman-6.0 | paul | 26 Jan |
