IBM DB2 Spatial Writer: Feature Type Parameters

To access feature type parameters, click the gear icon on a feature type in the workspace. This opens the Feature Type Parameter Editor.

Tip  To always display the editor in FME Workbench, you can select View > Window Layout > Parameter Editor.

General

All feature types share similar General parameters, which may include Feature Type Name, Reader or Writer information, and Geometry.

In most Writer Feature Type parameter dialogs, you can also control Dynamic Schema Definitions. Some database formats accept Table or Index Qualifier prefixes on the output table feature type.

Important  These parameters apply only to a selected feature type. If a feature type parameter conflicts with reader or writer parameters, the feature type parameter takes precedence.

General

This parameter specifies the type of geometry for features to be written to the destination table.

db2_type

Database Type(s)

FME Representation

db2_none

Not applicable

No geometry

db2_point

 

POINT

Single point geometry.

fme_geometry = fme_point

fme_type = fme_point

MULTIPOINT

Aggregate containing one or more points.

fme_geometry = fme_aggregate

fme_type = fme_point

db2_line

 

LINESTRING

Single line geometry.

fme_geometry = fme_line

fme_type = fme_line

MULTILINESTRING

An aggregate of linestrings.

fme_geometry = fme_aggregate

fme_type = fme_line

db2_polygon

 

POLYGON

A single polygon or donut geometry.

fme_geometry = fme_polygon or fme_donut

fme_type = fme_polygon

MULTIPOLYGON

An aggregate of simple polygons or donut polygons.

fme_geometry = fme_aggregate

fme_type = fme_polygon

When appending to an existing table, if the value of this parameter is incompatible with the geometry column type of the spatial column in the existing table, expect translation failure.

When inserting a geometry, if the type of the geometry is incompatible with the value of this parameter, the translation will fail.

The Format Parameter Write As Multi (see below) modifies this parameter.

Table Settings: General

  • No: The table will be created if it does not exist.
  • Yes: The table will be dropped if it exists, then created.
  • Truncate: If the table does not exist, it will be created. If the table does exist, then all its rows will be deleted.

This parameter instructs the writer to perform Update operations on the table.

The parameter is a comma-separated list of column names (for example, ID,NAME). These column names are used to match the same-named attributes on an input feature against rows in the destination table. Matching rows in the destination table will be updated by the attribute values of the input feature.

Note  If this parameter and Delete Key Columns are both supplied, the translation will fail.

This parameter instructs the writer to perform Delete operations on the table.

The parameter is a comma-separated list of column names (for example, ID,NAME). These column names are used to match the same-named attributes on an input feature against rows in the destination table. Matching rows in the destination table will be deleted.

Note  If this parameter and Update Key Columns are both supplied, the translation will fail.

Table Settings: Spatial

This parameter specifies the name of a spatial column. If this parameter is left empty, it will inherit from the writer parameter Spatial Column.

This parameter determines whether the column specified by Spatial Column contains Geometry or Geography values. Inherit From Writer causes the feature type to retrieve the value of Spatial Type from the writer parameter Spatial Type.

These parameters are useful if the grid index size is different for selected tables. Compare the parameters in the IBM DB2 Spatial Writer Parameters.

  • Finest Spatial Grid Index Size: Sets the finest grid size for the spatial grid index.
  • Middle Spatial Grid Index Size : Sets the middle grid size for the spatial grid index.
  • Coarsest Spatial Grid Index Size: Sets the coarsest grid size for the spatial grid index.

This parameter is in effect only when creating a new table.

This parameter is a modifier for the Geometry parameter when its value is one of db2_linestring, db2_point, or db2_polygon.

This parameter can cause these Geometry values to be treated as MULTIPOINT, MULTILINESTRING, and MULTIPOLYGON, respectively.

In the table below, the behavior of this parameter is described in the context of Geometry = db2_point.

Yes

All incoming points will be written out as MULTIPOINT geometries.

All single-level point collections will be written out as MULTIPOINT geometries.

All nested point collections will be written out as GEOMETRYCOLLECTIONs.
No

All incoming points will be written out as POINT geometries.

All incoming collections of points, including nested point collections, will be flattened and written out, one row per point.
First Feature

The first input feature determines whether this parameter is set to Yes or No:

  • If the first input feature is a point collection, then this parameter is set to Yes.
  • If the first input feature is a point, then this parameter is set to No.

Geometry type mismatches result in translation failure. See Geometry above for details.

Spatial Reference

These parameters are used only when creating new tables.

Note  To set the Min X, Min Y, and Scale Factor for all feature types on the writer, set the writer parameter. You can override the writer defaults by specifying non-default values here.

Parameter Reference

Description

db2_offset_x,

db2_offset_y

db2_offset_x and db2_offset_y correspond to the columns X_OFFSET (and MIN_X) and Y_OFFSET (and MIN_Y) in the DB2GSE.ST_SPATIAL_REFERENCE_SYSTEMS catalog view.

These parameters specify the minimum x (y) coordinate of the spatial reference system for the target table. If a geometry feature has x (y) coordinates below this value, then the feature is rejected or translation is stopped, depending on the value of the writer parameter Abort Translation on Bad Data.

Note  Values that are not set to 0 (the default), override the global Min X, Min Y parameters.

Data Type: DOUBLE.

db2_scale_x

db2_scale_x corresponds to the column X_SCALE and Y_SCALE in the DB2GSE.ST_SPATIAL_REFERENCE_SYSTEMS catalog view. Y_SCALE is constrained by the database to be identical to X_SCALE.

This parameter specifies the resolution of the spatial reference system. The resolution of the spatial reference system is equal to 1 divided by db2_scale_x. For example, if db2_scale_x is 1, all coordinates will be rounded to integers. As another example, if db2_scale_x is 10, 1/10 is 0.1, and all coordinates will be rounded to the nearest 0.1, which means a coordinate value of 2.149 will be written as 2.1.

Note  If the value is not set to 1 (the default), this overrides the global Scale Factor (X_SCALE) parameter.

The parameters db2_offset_x, db2_offset_y, and db2_scale_x together define the maximum x and y coordinates in the spatial reference system for the target table, which are stored as MAX_X and MAX_Y in the DB2GSE.ST_SPATIAL_REFERENCE_SYSTEMS catalog view. If a geometry feature has x (y) coordinates above MAX_X (MAX_Y), then the feature is rejected or translation is stopped, depending on the value of the writer parameter Abort Translation on Bad Data.

Data Type: DOUBLE.

Advanced

Specifies a SQL query to be used to define the results.