ST_UNREGISTER_SPATIAL_COLUMN procedure

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 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 constraint that Db2® Spatial Extender placed on this table to ensure that the geometry values in this spatial column are all represented in the same spatial reference system.

Authorization

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

Syntax

Read syntax diagramSkip visual syntax diagramDB2GSE.ST_UNREGISTER_SPATIAL_COLUMN( table_schemanull,table_name,column_name, msg_code , msg_text )

Parameter descriptions

table_schema
Names 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 table_schema value is converted to uppercase unless you enclose it in double quotation marks.

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

table_name
Specifies 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 table_name value is converted to uppercase unless you enclose it in double quotation marks.

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

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

The column_name value is converted to uppercase unless you enclose it in double quotation marks.

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(1024).

Example

This example shows how to use the Db2 command line processor to invoke the ST_UNREGISTER_SPATIAL_COLUMN stored procedure. This example uses a Db2 CALL command to unregister the spatial column named LOCATION in the table named CUSTOMERS: 

call DB2GSE.ST_UNREGISTER_SPATIAL_COLUMN(NULL,'CUSTOMERS','LOCATION',?,?)

The two question marks at the end of this CALL command represent the output parameters, msg_code and msg_text. The values for these output parameters are displayed after the stored procedure runs.