ST_CoordDim method for type ST

ST_CoordDim method for type ST_Geometry

Returns the number of coordinate dimensions stored with each point of the ST_Geometry value.

Syntax

geometry-expression.ST_CoordDim()

Returns

SMALLINT Returns a value between 2 and 4 indicating the number of coordinate dimensions stored with each point of the ST_Geometry value.

The ST_CoordDim method returns the number of coordinates stored within each point in the geometry. All geometries have at least two coordinate dimensions. For geographic spatial reference systems, these are the latitude and longitude of the point. For other spatial reference system, these coordinates are the X and Y positions of the point.

Geometries can optionally have Z and M values associated with each of the points in the geometry. These additional coordinate values are not considered when computing spatial relations or set operations, but they can be used to record additional information. For example, the measure value (M) can be used to record the pollution at various points within a geometry. The Z value usually is used to indicate elevation, but that interpretation is not imposed by the database server.

The following values may be returned by the ST_CoordDim method:

2 The geometry contains only two coordinates (either latitude/longitude or X/Y).
3 The geometry contains one additional coordinate (either Z or M) for each point.
4 The geometry contains two additional coordinate (both Z and M) for each point.

Note

Spatial operations that combine geometries using set operations do not preserve any Z or M values associated with the points of the geometry.

Note

By default, ST_CoordDim uses the original format for a geometry, if it is available. Otherwise, the internal format is used. For more information about internal and original formats, see STORAGE FORMAT clause, CREATE SPATIAL REFERENCE SYSTEM statement.

Standards and compatibility

Example

The following example returns the result 2.

SELECT NEW ST_Point(1.0, 1.0).ST_CoordDim()

The following example returns the result 3.

SELECT NEW ST_Point(1.0, 1.0, 1.0, 0).ST_CoordDim()

The following example returns the result 3.

SELECT NEW ST_Point('Point M (1 1 1)' ).ST_CoordDim()

The following example returns the result 4.

SELECT NEW ST_Point('Point ZM (1 1 1 1)' ).ST_CoordDim()

Discuss this page in DocCommentXchange.