User's Guide and Reference

db2gse.gse_run_gc

Use this stored procedure to run a geocoder in batch mode. For information about this task, see Running the geocoder in batch mode.

For an example of the code for invoking this stored procedure, see the C function gseRunGC 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 hold one of the following authorities or privileges:

Input parameters

Table 28. Input parameters for the db2gse.gse_run_gc stored procedure.
Name Data type Description
layerSchema VARCHAR(30) Name of the schema to which the table or view 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_run_gc is invoked.

layerTable VARCHAR(128) Name of the table that contains the column into which the geocoded data is to be inserted.

This parameter is not nullable.

layerColumn VARCHAR(128) Name of the column into which the geocoded data is to be inserted.

This parameter is not nullable.

gcId INTEGER Identifier of the geocoder that you want to run.

This parameter is nullable.

To find out the identifiers of registered geocoders, consult the DB2GSE.SPATIAL_GEOCODER catalog view.

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 nullable.

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 nullable.

whereClause VARCHAR(256) The body of the WHERE clause. It defines a restriction on the set of records to be geocoded. The clause can reference any attribute column in the table that the geocoder is to operate on.

This parameter is nullable.

commitScope INTEGER Number of records per checkpoint.

This parameter is nullable.

Output parameters

Table 29. Output parameters for the db2gse.gse_run_gc 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.


[ Top of Page | Previous Page | Next Page ]