ST_MultiPoint function

The ST_MultiPoint function constructs a multipoint from a given input.

The input can be given in one of the following formats:

A well-known text representation
A well-known binary representation
A shape representation
A representation in the geography markup language (GML)

An optional spatial reference system identifier can be specified to indicate the spatial reference system the resulting multipoint is in.

If the well-known text representation, the well-known binary representation, the shape representation, or the GML representation is null, then null is returned.

Syntax

Parameters

wkt

A value of type CLOB(2G) that contains the well-known text representation of the resulting multipoint.

wkb

A value of type BLOB(2G) that contains the well-known binary representation of the resulting multipoint.

gml

A value of type CLOB(2G) that represents the resulting multipoint using the geography markup language.

shape

A value of type BLOB(2G) that represents the shape representation of the resulting multipoint.

srs_id

A value of type INTEGER that identifies the spatial reference system for the resulting multipoint.

If the srs_id parameter is omitted, the spatial reference system with the numeric identifier 0 (zero) is used.

If srs_id does not identify a spatial reference system listed in the catalog view DB2GSE.ST_SPATIAL_REFERENCE_SYSTEMS, then an exception condition is raised (SQLSTATE 38SU1).

Return type

db2gse.ST_Point

Example

In the following example, the lines of results have been reformatted for readability. The spacing in your results will vary according to your online display.

This example illustrates how ST_MultiPoint can be used to create and insert a multipoint from its well-known text representation. The record that is inserted has ID = 1110, and the geometry is a multipoint in spatial reference system 1. The multipoint is in the well-known text representation of a multipoint. The X and Y coordinates for this geometry are: (1, 2) (4, 3) (5, 6).


SET CURRENT FUNCTION PATH = CURRENT FUNCTION PATH, db2gse
CREATE TABLE sample_mpoints (id INTEGER, geometry ST_MultiPoint)

INSERT INTO sample_mpoints
  VALUES (1110, ST_MultiPoint ('multipoint (1 2, 4 3, 5 6) )', 1))

The following SELECT statement returns the multipoint that was recorded in the table:


SELECT id, CAST( ST_AsText(geometry) AS VARCHAR(90)) MULTIPOINT
  FROM sample_mpoints
  WHERE id = 1110

Results:


ID         MULTIPOINT
---------- -----------------------------------------------------
      1110 MULTIPOINT (1.00000000 2.00000000, 4.00000000 
           3.00000000, 5.00000000 6.00000000)