geometry-expression.ST_AsKML([ format])

The ST_AsKML method returns a KML string representing the geometry. A number of different formats are supported (with associated options) and the desired format is selected using the optional format parameter. If the format parameter is not specified, the default is 'KML'.

The format string defines an output format and parameters to the format. The format string has one of the following formats:

format-name

format-name(parameter1=value1;parameter2=value2;...)

parameter1=value1;parameter2=value2;...

The first format specifies the format name and no parameters. All format parameters use their default values. The second format specifies the format name and a list of named parameter values. Parameters that are not supplied use their default values. The last format specifies only parameter values, and the format name defaults to 'KML'.

The following format names may be used:

The following format parameters can be specified:

The following example returns the result <Point><coordinates>1,2,3,4</coordinates></Point>.

SELECT NEW ST_Point( 1.0, 2.0, 3.0, 4.0, 4326 ).ST_AsKML()

The following example returns the result <Point><coordinates>1,2,3,4</coordinates></Point>.

SELECT NEW ST_Point( 1.0, 2.0, 3.0, 4.0, 4326 ).ST_AsKML('KML(Version=2)')

The following returns the result <kml:Point><kml:coordinates>1,2,3,4</kml:coordinates></kml:Point>. The Namespace=global parameter provides a dedicated ("kml") prefix for the given element and its sub elements. This is useful when the query is used within an aggregate operation, such that, some top level element defines the namespace for the "kml" prefix.

SELECT NEW ST_Point( 1.0, 2.0, 3.0, 4.0, 4326 ).ST_AskML('KML(Version=2;Namespace=global)')

The following returns the result <Point><coordinates>1,2,3,4</coordinates></Point>. No namespace information is included in the output.

SELECT NEW ST_Point( 1.0, 2.0, 3.0, 4.0, 4326 ).ST_AsKML('KML(Version=2;Namespace=none)')

The following returns the result <Point xmlns="http://www.opengis.net/kml/2.2"><coordinates>1,2,3,4</coordinates></Point>. The default xml namespace is used.

SELECT NEW ST_Point( 1.0, 2.0, 3.0, 4.0, 4326 ).ST_AsKML('KML(Version=2;Namespace=default)')

The following returns the result <Point><altitudeMode>absolute</altitudeMode><coordinates>1,2,3,4</coordinates></Point>. An AltitudeMode sub element is included in the output.

SELECT NEW ST_Point( 1.0, 2.0, 3.0, 4.0, 4326 ).ST_AsKML('SubElement=<altitudeMode>absolute</altitudeMode>')