ST_drop_coordsys

Use this stored procedure to delete information about a coordinate system from the database.

When this stored procedure is processed, information about the coordinate system is removed from the DB2GSE.ST_COORDINATE_SYSTEMS catalog view.

Restriction:
You cannot drop a coordinate system on which a spatial reference system is based.

Authorization

The user ID under which the stored procedure is invoked must have either SYSADM or DBADM authority.

Syntax

Read syntax diagramSkip visual syntax diagramsysproc.ST_drop_coordsys(coordsys_name,msg_code,msg_text)

Parameter descriptions

coordsys_name
Uniquely identifies the coordinate system. You must specify a non-null value for this parameter.

Specify the coordsys_name value in uppercase letters.

The data type of this parameter is VARCHAR(130).

Output parameters

msg_code
Specifies the message code that is returned from the stored procedure. The value of this output parameter identifies the error, success, or warning condition that was encountered during the processing of the procedure. If this parameter value is for a success or warning condition, the procedure finished its task. If the parameter value is for an error condition, no changes to the database were performed.

The data type of this output parameter is INTEGER.

msg_text
Specifies the actual message text, associated with the message code, that is returned from the stored procedure. The message text can include additional information about the success, warning, or error condition, such as where an error was encountered.

The data type of this output parameter is VARCHAR(4096).

When the message code that is returned is 0 (zero), the message text parameter is set to null.

Example

This example shows how to use a Db2 CALL statement to invoke the ST_drop_coordsys stored procedure. This example uses a Db2 CALL statement to delete a coordinate system named NORTH_AMERICAN_TEST from the database:

call sysproc.ST_drop_coordsys('NORTH_AMERICAN_TEST',?,?)

The two question marks at the end of this CALL statement represent the output parameters, msg_code and msg_text. The values for these output parameters are returned after the stored procedure is called.