DB2 Plugin

Supports direct access to a DB2 database.

A couple of really good things have happened for DB2 support recently. We have obtained permission to distribute the DB2 driver with GeoTools, and you can now download a free community version of DB2 .



Note that the groupId is org.geotools.jdbc for this and other JDBC plugin modules.


Connection Parameters




Must be the string db2


Machine name or IP address to connect to


Port number to connect to, default 50000


The database schema to access


The database to connect to


User name




Here is an example of connecting:

Map params = new HashMap();
params.put("dbtype", "db2");        //must be db2 or DB2
params.put("host", "localhost");    //the name or ip address of the machine running DB2
params.put("port", "50000");        //the port that DB2 is running on (generally 50000)
params.put("database", "geotools"); //the name of the database to connect to.
params.put("user", "db2admin");     //the user to connect with
params.put("passwd", "adminpw");    //the password of the user
params.put("tabschema", "SPEAR");   //the table schema

DataStore datastore = DataStoreFinder.getDataStore(params);

Advanced Connection Parameters

Additional connection parameters are available to configure connection pool use, or to feed in your own DataSource.

For more information check the Java docs for:

  • DB2NGJNDIDataStoreFactory

  • DB2NGDataStoreFactory

Advanced GeoTools Parameters



loose bbox

Flag controlling loose bbox comparisons, default is true

use selectivity

Flag to raise the priority of spatial indices for the db2 optimizer, default is false

Example use:

params.put(DB2NGDataStoreFactory.LOOSEBBOX, true );
params.put(DB2BNGDataStoreFactory.USE_SELECTIVITY, true );

Registering spatial columns

It is necessary to register the spatial columns of a table:

db2se register_spatial_column mydb
     -tableName mytable -columnName mycolumn -srsName USA_SRS_1


If a SQL view includes a spatial column, the column has to be registered for this view.


If a historical table includes a spatial column, this column has to be registered too. (See DB2 temporal support, since DB2 version 10)

Speeding up extent calculation

Since DB2 Spatial Extender V10 it is possible to store the extent of a geometry column during registration:

db2se register_spatial_column mydb
     -tableName mytable -columnName mycolumn -srsName USA_SRS_1 -computeExtents 1


This makes only sense if the table is populated before registration and there will be no future modifications altering the extent dramatically.

Paging Support

Paging support is necessary to retrieve only a subset of a query result. (e.g. rows numbered 100 - 200). Many databases support the SQL keywords LIMIT and OFFSET, Oracle uses a pseudo column called ROWNUM. This plugin uses a strategy depending on the DB2 compatibility mode.

  • In MYSQL compatibility mode, LIMIT and OFFSET is used

  • In Oracle compatibility mode, ROWNUM is used

  • Fetch needed rows and ignore the unneeded rows (e.g. fetch rows 1 - 200 and ignore rows from 1-100). This may result in very bad performance. Using a scrollable cursor would not help since BLOBs (vector data) are not supported for such cursors in DB2.

The strategy used can be found in the log file. If no paging support is enabled, the log file contains a warning:

Try to set MySql or Oracle compatibility mode

The above commands enable MYSQL compatibility, the command for Oracle compatibility mode is:


On success the log file contains:

Using LIMIT OFFSET for paging support


Using Oracle ROWNUM for paging support