User's Guide and Reference

Stored procedures

This chapter documents the stored procedures that allow you to build a geographic information system with DB2 Spatial Extender. When you enable and use DB2 Spatial Extender from the Control Center, you invoke these stored procedures implicitly. For example, when you click OK from a DB2 Spatial Extender window, DB2 calls the stored procedure or stored procedures associated with that window for you. Alternatively, you can invoke the stored procedures explicitly in an application program. It is advisable to include the header file, db2gse.h, in such a program. This file contains the macro definitions for the constants that you assign to the stored procedures' parameters. On AIX, it is stored in the $DB2INSTANCE/sqllib/include/ directory. On Windows NT, it is stored in the %DB2PATH%\include\ directory.

Attention:
All character string constants for stored procedures' input parameters are case-sensitive. To find out which parameters require these constants, see the tables in this chapter.

Before you can invoke a stored procedure, either implicitly or explicitly, you must be connected to the database in which DB2 Spatial Extender is installed. The first stored procedure that you use is db2gse.gse_enable_db. It enables the database for spatial operations. You can use the other stored procedures only after the database has been enabled.

The implementations of the stored procedures are archived in the db2gse library on the DB2 Spatial Extender server.

You can use the following lists to look up the stored procedures either by their names or by the tasks that they carry out. The first list presents the names:

• db2gse.gse_disable_autogc
• db2gse.gse_disable_db
• db2gse.gse_disable_sref
• db2gse.gse_enable_autogc
• db2gse.gse_enable_db
• db2gse.gse_enable_idx
• db2gse.gse_enable_sref
• db2gse.gse_export_shape
• db2gse.gse_import_sde
• db2gse.gse_import_shape
• db2gse.gse_register_gc
• db2gse.gse_register_layer
• db2gse.gse_run_gc
• db2gse.gse_unregist_gc
• db2gse.gse_unregist_layer

The next list presents the tasks that the stored procedures carry out.

• Creating an index for a spatial column (see db2gse.gse_enable_idx).
• Creating a spatial reference system (see db2gse.gse_enable_sref).
• Disabling a geocoder so that it cannot automatically keep spatial columns synchronized with their corresponding attribute columns (see db2gse.gse_disable_autogc).
• Disabling support for spatial operations in a database (see db2gse.gse_disable_db).
• Dropping a spatial reference system (see db2gse.gse_disable_sref).
• Enabling a database to support spatial operations (see db2gse.gse_enable_db).
• Enabling a geocoder to automatically keep spatial columns synchronized with their corresponding attribute columns (see db2gse.gse_enable_autogc).
• Exporting a layer and its associated table to a shape file (see db2gse.gse_export_shape).
• Importing a layer and its associated table from an ESRI_SDE transfer file (see db2gse.gse_import_sde).
• Importing a layer and its associated table from a shape file (see db2gse.gse_import_shape).
• Registering a geocoder other than the default geocoder (see db2gse.gse_register_gc).
• Registering a spatial column as a layer (see db2gse.gse_register_layer).
• Running a geocoder in batch mode (see db2gse.gse_unregist_gc).
• Unregistering a geocoder other than the default geocoder (see db2gse.gse_unregist_layer).
• Unregistering a layer (see db2gse.gse_unregist_layer).

For information about the sequences in which you can perform these tasks, see About DB2 Spatial Extender and Writing applications for DB2 Spatial Extender.