ST_unregister_spatial_column

Use this stored procedure to remove the registration of a spatial column.

The stored procedure removes the registration by:
  • Removing association of the spatial reference system with the spatial column. The DB2GSE.ST_GEOMETRY_COLUMNS catalog view continues to contain the spatial column, but the column is no longer associated with any spatial reference system.
  • For a base table, dropping the triggers that IBM® Spatial Support for Db2 for z/OS® placed on this table to ensure that the geometry values in this spatial column are all represented in the same spatial reference system.

If you drop the table that contains the spatial column before calling the ST_unregister_spatial_column stored procedure, then the triggers are still dropped but an error is returned that the table does not exist.

Authorization

The user ID under which this stored procedure is invoked must hold one of the following authorities or privileges:
  • SYSADM or DBADM authority
  • All table or view privileges on this table

Syntax

Read syntax diagramSkip visual syntax diagramsysproc.ST_unregister_spatial_column( table_schemanull,table_name,column_name,msg_code,msg_text)

Parameter descriptions

table_schema
Identifies the schema to which the table that is specified in the table_name parameter belongs. Although you must specify a value for this parameter, the value can be null. If this parameter is null, the value in the CURRENT SCHEMA special register is used as the schema name for the table or view.

The data type of this parameter is VARCHAR(128) or, if you enclose the value in double quotation marks, VARCHAR(130).

table_name
Identifies the unqualified name of the table that contains the column that is specified in the column_name parameter. You must specify a non-null value for this parameter.

The data type of this parameter is VARCHAR(128) or, if you enclose the value in double quotation marks, VARCHAR(130).

column_name
Identifies the spatial column that you want to unregister. You must specify a non-null value for this parameter.

The data type of this parameter is VARCHAR(128) or, if you enclose the value in double quotation marks, 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 the Db2 CALL statement to invoke the ST_unregister_spatial_column stored procedure. This example uses a Db2 CALL statement to unregister the spatial column named LOCATION in the table named CUSTOMERS: 

call sysproc.ST_unregister_spatial_column(NULL,'CUSTOMERS','LOCATION',?,?)

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.