]> granicus.if.org Git - postgis/commitdiff
update with new functions moved over
authorRegina Obe <lr@pcorp.us>
Sun, 7 Dec 2008 04:05:51 +0000 (04:05 +0000)
committerRegina Obe <lr@pcorp.us>
Sun, 7 Dec 2008 04:05:51 +0000 (04:05 +0000)
git-svn-id: http://svn.osgeo.org/postgis/branches/1.3@3371 b70326c6-7e19-0410-871a-916f4a2858ee

postgis_comments.sql

index 9b71c29231f785a410c2cbb0d68872ee7346c026..3d5d957229a3880a53ea6ddbe84a5429f23217f3 100644 (file)
@@ -38,7 +38,7 @@ COMMENT ON FUNCTION PostGIS_Scripts_Released() IS 'Returns the version number of
 COMMENT ON FUNCTION PostGIS_Uses_Stats() IS 'Returns TRUE if STATS usage has been enabled.';\r
                        \r
 COMMENT ON FUNCTION PostGIS_Version() IS 'Returns PostGIS version number and compile-time options.';\r
-                               \r
+                                       \r
 COMMENT ON FUNCTION Probe_Geometry_Columns() IS 'Scans all tables with PostGIS geometry constraints and adds them to the geometry_columns table if they are not there.';\r
                        \r
 COMMENT ON FUNCTION UpdateGeometrySRID(varchar , varchar , integer ) IS 'args: table_name, column_name, srid - Updates the SRID of all features in a geometry column, geometry_columns metadata and srid table constraint';\r
@@ -119,6 +119,8 @@ COMMENT ON FUNCTION ST_GeometryN(geometry , integer ) IS 'args: geomA, n - Retur
                        \r
 COMMENT ON FUNCTION ST_GeometryType(geometry ) IS 'args: g1 - Return the geometry type of the ST_Geometry value.';\r
                        \r
+COMMENT ON FUNCTION ST_HasBBox(geometry ) IS 'args: geomA - Returns TRUE if the bbox of this geometry is cached, FALSE otherwise.';\r
+                       \r
 COMMENT ON FUNCTION ST_InteriorRingN(geometry , integer ) IS 'args: a_polygon, n - Return the Nth interior linestring ring of the polygon geometry. Return NULL if the geometry is not a polygon or the given N is out of range.';\r
                        \r
 COMMENT ON FUNCTION ST_IsClosed(geometry ) IS 'args: g - Returns TRUE if the LINESTRINGs start and end points are coincident.';\r
@@ -159,6 +161,8 @@ COMMENT ON FUNCTION ST_Y(geometry ) IS 'args: a_point - Return the Y coordinate
                        \r
 COMMENT ON FUNCTION ST_Z(geometry ) IS 'args: a_point - Return the Z coordinate of the point, or NULL if not available. Input must be a point.';\r
                        \r
+COMMENT ON FUNCTION ST_AddBBox(geometry ) IS 'args: geomA - Add bounding box to the geometry.';\r
+                       \r
 COMMENT ON FUNCTION ST_AddPoint(geometry, geometry) IS 'args: linestring, point - Adds a point to a LineString before point <position> (0-based index).';\r
                        \r
 COMMENT ON FUNCTION ST_AddPoint(geometry, geometry, integer) IS 'args: linestring, point, position - Adds a point to a LineString before point <position> (0-based index).';\r
@@ -167,6 +171,8 @@ COMMENT ON FUNCTION ST_Affine(geometry , float , float , float , float , float ,
                        \r
 COMMENT ON FUNCTION ST_Affine(geometry , float , float , float , float , float , float ) IS 'args: geomA, a, b, d, e, xoff, yoff - Applies a 3d affine transformation to the geometry to do things like translate, rotate, scale in one step.';\r
                        \r
+COMMENT ON FUNCTION ST_DropBBox(geometry ) IS 'args: geomA - Drop the bounding box cache from the geometry.';\r
+                       \r
 COMMENT ON FUNCTION ST_Force_2D(geometry ) IS 'args: geomA - Forces the geometries into a "2-dimensional mode" so that all output representations will only have the X and Y coordinates.';\r
                        \r
 COMMENT ON FUNCTION ST_Force_3D(geometry ) IS 'args: geomA - Forces the geometries into XYZ mode. This is an alias for ST_Force_3DZ.';\r
@@ -390,8 +396,30 @@ COMMENT ON FUNCTION ST_Locate_Along_Measure(geometry , float ) IS 'args: ageom_w
                        \r
 COMMENT ON FUNCTION ST_Locate_Between_Measures(geometry , float , float ) IS 'args: geomA, measure_start, measure_end - Return a derived geometry collection value with elements that match the specified range of measures inclusively. Polygonal elements are not supported.';\r
                        \r
+COMMENT ON FUNCTION AddAuth(text ) IS 'args: auth_token - Add an authorization token to be used in current transaction.';\r
+                       \r
+COMMENT ON FUNCTION CheckAuth(text , text , text ) IS 'args: a_schema_name, a_table_name, a_key_column_name - Creates trigger on a table to prevent/allow updates and deletes of rows based on authorization token.';\r
+                       \r
+COMMENT ON FUNCTION CheckAuth(text , text ) IS 'args: a_table_name, a_key_column_name - Creates trigger on a table to prevent/allow updates and deletes of rows based on authorization token.';\r
+                       \r
+COMMENT ON FUNCTION DisableLongTransactions() IS 'Disable long transaction support. This function removes the long transaction support metadata tables, and drops all triggers attached to lock-checked tables.';\r
+                       \r
+COMMENT ON FUNCTION EnableLongTransactions() IS 'Enable long transaction support. This function creates the required metadata tables, needs to be called once before using the other functions in this section. Calling it twice is harmless.';\r
+                       \r
+COMMENT ON FUNCTION LockRow(text , text , text , text, timestamp) IS 'args: a_schema_name, a_table_name, a_row_key, an_auth_token, expire_dt - Set lock/authorization for specific row in table';\r
+                       \r
+COMMENT ON FUNCTION LockRow(text , text , text, timestamp) IS 'args: a_table_name, a_row_key, an_auth_token, expire_dt - Set lock/authorization for specific row in table';\r
+                       \r
+COMMENT ON FUNCTION LockRow(text , text , text) IS 'args: a_table_name, a_row_key, an_auth_token - Set lock/authorization for specific row in table';\r
+                       \r
+COMMENT ON FUNCTION UnlockRows(text ) IS 'args: auth_token - Remove all locks held by specified authorization id. Returns the number of locks released.';\r
+                       \r
 COMMENT ON AGGREGATE ST_Accum(geometry) IS 'args: geomfield - Aggregate. Constructs an array of geometries.';\r
                        \r
+COMMENT ON FUNCTION ST_Box2D(geometry ) IS 'args: geomA - Returns a BOX2D representing the maximum extents of the geometry.';\r
+                       \r
+COMMENT ON FUNCTION ST_Box3D(geometry ) IS 'args: geomA - Returns a BOX3D representing the maximum extents of the geometry.';\r
+                       \r
 COMMENT ON FUNCTION ST_Estimated_Extent(text , text , text ) IS 'args: schema_name, table_name, geocolumn_name - Return the estimated extent of the given spatial table. The estimated is taken from the geometry columns statistics. The current schema will be used if not specified.';\r
                        \r
 COMMENT ON FUNCTION ST_Estimated_Extent(text , text ) IS 'args: table_name, geocolumn_name - Return the estimated extent of the given spatial table. The estimated is taken from the geometry columns statistics. The current schema will be used if not specified.';\r
@@ -405,4 +433,16 @@ COMMENT ON FUNCTION ST_Expand(box3d , float) IS 'args: g1, units_to_expand - Ret
 COMMENT ON AGGREGATE ST_Extent(geometry) IS 'args: geomfield - an aggregate function that returns the bounding box that bounds rows of geometries.';\r
                        \r
 COMMENT ON FUNCTION ST_Mem_Size(geometry ) IS 'args: geomA - Returns the amount of space (in bytes) the geometry takes.';\r
+                       \r
+COMMENT ON FUNCTION ST_XMax(box3d ) IS 'args: aGeomorBox2DorBox3D - Returns X maxima of a bounding box 2d or 3d or a geometry.';\r
+                       \r
+COMMENT ON FUNCTION ST_XMin(box3d ) IS 'args: aGeomorBox2DorBox3D - Returns X minima of a bounding box 2d or 3d or a geometry.';\r
+                       \r
+COMMENT ON FUNCTION ST_YMax(box3d ) IS 'args: aGeomorBox2DorBox3D - Returns Y maxima of a bounding box 2d or 3d or a geometry.';\r
+                       \r
+COMMENT ON FUNCTION ST_YMin(box3d ) IS 'args: aGeomorBox2DorBox3D - Returns Y minima of a bounding box 2d or 3d or a geometry.';\r
+                       \r
+COMMENT ON FUNCTION ST_ZMax(box3d ) IS 'args: aGeomorBox2DorBox3D - Returns Z minima of a bounding box 2d or 3d or a geometry.';\r
+                       \r
+COMMENT ON FUNCTION ST_ZMin(box3d ) IS 'args: aGeomorBox2DorBox3D - Returns Z minima of a bounding box 2d or 3d or a geometry.';\r
                        
\ No newline at end of file