ST_register_spatial_column

Use this stored procedure to register a spatial column and to associate a spatial reference system (SRS) with it.

When this stored procedure is processed, information about the spatial column that is being registered is added to the DB2GSE.ST_GEOMETRY_COLUMNS catalog view. Registering a spatial column creates a constraint on the table, if possible, to ensure that all geometries use the specified SRS.

Authorization

The user ID under which this stored procedure is invoked must hold one of the following authorities or privileges:
  • SYSADM or DBADM authority on the database that contains the table to which the spatial column that is being registered belongs
  • All table or view privileges on this table

Syntax

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

Parameter descriptions

table_schema
Identifies the schema to which the table or view 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 or view that contains the column that is being registered. 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 column that is being registered. 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).

srs_name
Identifies the spatial reference system that is to be used for this spatial column. You must specify a non-null value for this parameter.

The srs_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(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_register_spatial_column stored procedure. This example uses a Db2 CALL statement to register the spatial column named LOCATION in the table named CUSTOMERS. This CALL statement specifies the srs_name parameter value as USA_SRS_1: 

call sysproc.ST_register_spatial_column(NULL,'CUSTOMERS','LOCATION',
     'USA_SRS_1',?,?)

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.