ST_UNREGISTER_GEOCODER procedure

Use this stored procedure to unregister a geocoder.

Restriction:
You cannot unregister a geocoder if it is specified in the geocoding setup for any column.

To determine whether a geocoder is specified in the geocoding setup for a column, check the DB2GSE.ST_GEOCODING and DB2GSE.ST_GEOCODING_PARAMETERS catalog views. To find information about the geocoder that you want to unregister, consult the DB2GSE.ST_GEOCODERS catalog view.

Authorization

The user ID under which this stored procedure is invoked must hold DBADM authority on the database that contains the geocoder that is to be unregistered.

Syntax

Read syntax diagramSkip visual syntax diagramDB2GSE.ST_UNREGISTER_GEOCODER( geocoder_name, msg_code , msg_text )

Parameter descriptions

geocoder_name
Uniquely identifies the geocoder. You must specify a non-null value for this parameter.

The geocoder_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_GEOCODER stored procedure. This example uses a Db2 CALL command to unregister the geocoder named SAMPLEGC: 

call DB2GSE.ST_UNREGISTER_GEOCODER('SAMPLEGC',?,?)

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.