User's Guide and Reference

db2gse.gse_enable_autogc

Use this stored procedure to:

For an example of the code for invoking this stored procedure, see the C function gseEnableAutoGC in the sample program. For information about this program, see Writing applications for DB2 Spatial Extender.

Authorization

The user ID under which this stored procedure is invoked must have authorization in the form of an authority, privilege, or set of privileges; specifically:

Input parameters

Table 11. Input parameters for the db2gse.gse_enable_autogc stored procedure.
Name Data type Description
operMode SMALLINT Value that indicates whether the triggers that initiate the geocoding are to be created for the first time or to be reactivated after being temporarily disabled.

This parameter is not nullable.

Comment: To create the triggers, use the GSE_AUTOGC_CREATE macro. To reactivate them, use the GSE_AUTOGC_RECREATE macro. To find out what values are associated with these macros, consult the db2gse.h file. On AIX, this file is stored in the $DB2INSTANCE/sqllib/include/ directory. On Windows NT, it is stored in the %DB2PATH%\include\ directory.

layerSchema VARCHAR(30) Name of the schema to which the table specified in the layerTable parameter belongs.

This parameter is nullable.

Comment: If you do not supply a value for the layerSchema parameter, it will default to the user ID under which the db2gse.gse_enable_autogc stored procedure is invoked.

layerTable VARCHAR(128) Name of the table that the triggers created or reactivated by this stored procedure are to operate on.

This parameter is not nullable.

layerColumn VARCHAR(128) Name of the spatial column that is to be maintained by the triggers that this stored procedure creates or reactivates.

This parameter is not nullable.

gcId INTEGER Identifier of the geocoder that will be invoked by the insert and update triggers that this stored procedure creates or reactivates.

This parameter is not nullable if the operMode parameter is set to GSE_AUTOGC_CREATE. It is nullable if operMode is set to GSE_AUTOGC_RECREATE.

precisionLevel INTEGER The degree to which source data must match corresponding reference data in order for the geocoder to process the source data successfully.

This parameter is not nullable if the operMode parameter is set to GSE_AUTOGC_CREATE. It is nullable if operMode is set to GSE_AUTOGC_RECREATE.

Comment: The precision level can range from 1 to 100 percent.

vendorSpecific VARCHAR(256) Technical information provided by the vendor; for example, the path and name of a file that the vendor uses to set parameters.

This parameter is not nullable if the operMode parameter is set to GSE_AUTOGC_CREATE. It is nullable if operMode is set to GSE_AUTOGC_RECREATE.

Output parameters

Table 12. Output parameters for the db2gse.gse_enable_autogc stored procedure.
Name Data type Description
msgCode INTEGER Code associated with the messages that the caller of this stored procedure can return.
Reserved VARCHAR(1024) Complete error message, as constructed at the DB2 Spatial Extender server.

Restrictions


[ Top of Page | Previous Page | Next Page ]