1
<?xml version="1.0" encoding="UTF-8"?>
3
<title>PostGIS Reference</title>
5
<para>The functions given below are the ones which a user of PostGIS is
6
likely to need. There are other functions which are required support
7
functions to the PostGIS objects which are not of use to a general
11
<para>PostGIS has begun a transition from the existing naming convention
12
to an SQL-MM-centric convention. As a result, most of the functions that
13
you know and love have been renamed using the standard spatial type (ST)
14
prefix. Previous functions are still available, though are not listed in
15
this document where updated functions are equivalent. These will be
16
deprecated in a future release.</para>
20
<title>OpenGIS Functions</title>
23
<title>Geometry Constructors</title>
27
<varlistentry id="ST_PolyFromWKB">
28
<term>ST_PolyFromWKB(bytea,[<srid>])</term>
31
<para>Makes a Geometry from WKB with the given SRID. If SRID is
32
not give, it defaults to -1.</para>
34
<para>OGC SPEC 3.2.7.2 - option SRID is from the conformance
37
<para>throws an error if WKB is not a POLYGON</para>
42
<term>ST_PolygonFromWKB(bytea,[<srid>])</term>
45
<para>Makes a Geometry from WKB with the given SRID. If SRID is
46
not give, it defaults to -1.</para>
48
<para>from the conformance suite</para>
50
<para>throws an error if WKB is not a POLYGON</para>
55
<term>ST_MPointFromWKB(bytea,[<srid>])</term>
58
<para>Makes a Geometry from WKB with the given SRID. If SRID is
59
not give, it defaults to -1.</para>
61
<para>OGC SPEC 3.2.7.2 - option SRID is from the conformance
64
<para>throws an error if WKB is not a MULTIPOINT</para>
69
<term>ST_MLineFromWKB(bytea,[<srid>])</term>
72
<para>Makes a Geometry from WKB with the given SRID. If SRID is
73
not give, it defaults to -1.</para>
75
<para>OGC SPEC 3.2.7.2 - option SRID is from the conformance
78
<para>throws an error if WKB is not a MULTILINESTRING</para>
83
<term>ST_MPolyFromWKB(bytea,[<srid>])</term>
86
<para>Makes a Geometry from WKB with the given SRID. If SRID is
87
not give, it defaults to -1.</para>
89
<para>OGC SPEC 3.2.7.2 - option SRID is from the conformance
92
<para>throws an error if WKB is not a MULTIPOLYGON</para>
97
<term>ST_GeomCollFromWKB(bytea,[<srid>])</term>
100
<para>Makes a Geometry from WKB with the given SRID. If SRID is
101
not give, it defaults to -1.</para>
103
<para>OGC SPEC 3.2.7.2 - option SRID is from the conformance
106
<para>throws an error if WKB is not a GEOMETRYCOLLECTION</para>
115
<title>SQL-MM Functions</title>
117
<para>This is a listing of the SQL-MM defined functions that PostGIS
118
currently supports. The implementations of these functions follow the
119
ArcSDE implementation, and thus deviate somewhat from the spec. These
120
deviations will be noted.</para>
122
<para>As of version 1.2.0, these functions have been implemented by
123
wrapping existing PostGIS functions. As a result, full support for curved
124
geometries may not be in place for many functions.</para>
127
<para>SQL-MM defines the default SRID of all geometry constructors as 0.
128
PostGIS uses a default SRID of -1.</para>
133
<term>ST_MLineFromWKB</term>
136
<para>Return a specified ST_MultiLineString value.</para>
138
<para>SQL-MM 3: 9.4.5</para>
143
<term>ST_MPointFromWKB</term>
146
<para>Return a specified ST_MultiPoint value.</para>
148
<para>SQL-MM 3: 9.2.5</para>
153
<term>ST_MPolyFromWKB</term>
156
<para>Return a specified ST_MultiPolygon value.</para>
158
<para>SQL-MM 3: 9.6.5</para>
163
<term>ST_PolyFromWKB</term>
166
<para>Return a specified ST_Polygon value.</para>
168
<para>SQL-MM 3: 8.3.7</para>
175
<title>ArcSDE Functions</title>
177
<para>Additional functions have been added to improve support for an
178
ArcSDE style interface.</para>
182
<term>SE_EnvelopesIntersect</term>
185
<para>Returns t (TRUE) if the envelopes of two geometries intersect;
186
otherwise, it returns f (FALSE).</para>
194
<para>Test if a geometry value has z coordinate values.</para>
199
<term>SE_IsMeasured</term>
202
<para>Test if a geometry value has m coordinate values.</para>
207
<term>SE_LocateAlong</term>
210
<para>Return a derived geometry collection value with elements that
211
match the specified measur.</para>
216
<term>SE_LocateBetween</term>
219
<para>Return a derived geometry collection value with elements that
220
match the specified range of measures inclusively.</para>
228
<para>Returns the m coordinate value of an ST_Point value.</para>
236
<para>Returns the z coordinate value of an ST_Point value</para>
added
removed
doc/reference_old.xml
