IBM DB2 Spatial Reader Parameters
Database Connection
Database
This is the ODBC Ddata Source Name (DSN) as configured using the DB2 client software.
Username and Password
Enter the username and password to access the database, user account, or wherever authentication is required.
When enabled, the database connection persists for the duration of an FME session.
For example, it may be desirable to maintain a connection when running a batch of 100 workspaces on the same database connection, which saves the processing time required to make and break a database connection.
FME considers the database connection to be the same when the database name, the username, and password are the same.
The time (seconds) after which to terminate a query to the database if it has not yet returned a connection/result.
If it is set to 0, there is no timeout. The default is 30.
Schemas for Tables
If this parameter is unset, then the Tables parameter will show tables from the current schema associated with the DSN entry.
If this parameter is set, the Tables parameter will show tables from all the selected schemas.
This parameter is also present in the Navigator Pane, where it specifies the schemas on which the Merge Filter operates.
Constraints
After specifying the database connection, click the Browse button (...) to select tables for import. A connection window appears while the system retrieves the tables from the database.
Once the Select Tables dialog appears, you can select one or more tables. Click OK to dismiss the window and add the selected table name(s) to the Tables parameter.
The WHERE clause parameter is used to constrain the row selection in tables chosen in the Tables parameter. FME will select only the rows (records) that match this condition.
The easiest method to construct a WHERE clause is by using the editor. Click the browse button (...) to open the editor, and use the SQL functions to construct the clause.
You can also type a WHERE clause directly in the parameter field:
|
Examples |
|---|
|
When querying integer and number data types: NUMLANES = 2 LENGTH > 2000 |
If the WHERE clause SQL is invalid, the translation will fail.
in the WHERE Clause editor.Schema Attributes
Use this parameter to expose Format Attributes in FME Workbench when you create a workspace:
- In a dynamic scenario, it means these attributes can be passed to the output dataset at runtime.
- In a non-dynamic scenario, this parameter allows you to expose additional attributes on multiple feature types. Click the browse button to view the available format attributes (which are different for each format) for the reader.
Use Search Envelope
|
A search envelope (also known as a bounding box) is a rectangular area that defines a geographic area. In FME, the easiest way to define a search envelope is to use search envelope parameters. Defining a search envelope is the most efficient method of selecting an area of interest because FME will read only the data that is necessary – it does not have to read an entire dataset. Search Envelope parameters apply to both vector and raster datasets and can be particularly efficient if the source format has a spatial index. Most FME readers have parameters to define the search envelope of data that is being read:
The parameters include the x and y coordinates of the bounding box as well as a parameter that defines the coordinate system. How to Define the Bounding Box Using the minimum and maximum x and y parameters, define a bounding box that will be used to filter the input features. Only features that intersect with the bounding box are returned. Note that the bounding box intersection is not a full geometry intersection (based on spatial relationships) that would be returned by a transformer like the SpatialFilter. Note If all four coordinates of the search envelope are left at 0, the search envelope will be disabled even if this option is checked.
|
|||||||
|
Search Envelope Coordinate System |
Specifies the coordinate system of the search envelope if it is different than the coordinate system of the data. The coordinate system associated with the data to be read must always be set if this parameter is set. If this parameter is set, the minimum and maximum points of the search envelope are reprojected from the Search Envelope Coordinate System to the reader’s coordinate system prior to applying the envelope. |
||||||
|
Clip to Search Envelope |
The underlying function for Use Search Envelope is an intersection; however, when Clip to Search Envelope is checked, a clipping operation is also performed.
|
||||||
The type of spatial relationship that must exist between the search envelope and the geometry in the target layer. Any supported relationship, in combination with Result of Spatial Comparison, can be used to filter the features being read.
For example, consider the following settings:
Spatial Relationship to Search Envelope = ST_Intersects
Result of Spatial Comparison = False
This would result in a spatial filter using DB2 Spatial’s native spatial function
DB2GSE.ST_Intersects( g1 geometry, g2 geometry) = 0
where g1 is the search envelope and g2 is the target feature. This will cause FME to return only those features that satisfy the spatial relationship above.
The following table lists the valid spatial relationships.
|
Search Method |
Description |
|
ST_CONTAINS |
Determines whether the search envelope is completely contained by the target feature. |
|
ST_CROSSES |
Determines whether the intersection of search envelope and the target feature results in a geometry object whose dimension is one less than the maximum dimension of the source geometries. Also determines if the intersection object contains points that are interior to both source geometries and are not equal to either of the source objects. |
|
ST_DISJOINT |
Determines whether the intersection of search envelope with the target feature is an empty set. |
|
ST_EQUALS |
Determines whether the search envelope and target feature are of the same type and have identical x,y coordinate values. |
|
ST_INTERSECTS |
Determines whether the intersection of search envelope and target feature does not result in an empty set. This is the exact opposite of DISJOINT. |
|
ST_ORDERINGEQUALS |
Determines whether the search envelope and target feature are equal and the coordinates are in the same order. |
|
ST_OVERLAPS |
Determines whether the search envelope and target feature overlap each other. |
|
ST_TOUCHES |
Determines whether any of the points common to search envelope and target feature intersect the interiors of both geometries. At least one geometry must be a linestring, polygon, multilinestring, multipolygon. |
|
ST_WITHIN |
Determines whether the target feature is completely within the search envelope. This is exactly opposite to CONTAINS. |
For more details, refer to the IBM DB2 Documentation.
The result to be used for the relationship specified in Spatial Relationship to Search Envelope.
Advanced
This parameter allows for the execution of SQL statements before opening a table for reading. For example, it may be necessary to create a temporary view before attempting to read from it.
For detailed information about SQL functions, click the corresponding menu item in the .
Available menu options depend on the format.
Multiple SQL commands can be delimited by a character specified using the FME_SQL_DELIMITER directive, embedded at the beginning of the SQL block. The single character following this directive will be used to split the SQL block into SQL statements, which will then be sent to the database for execution. Note: Include a space before the character.
For example:
FME_SQL_DELIMITER ; DELETE FROM instructors ; DELETE FROM people WHERE LastName='Doe' AND FirstName='John'
Multiple delimiters are not allowed and the delimiter character will be stripped before being sent to the database.
Any errors occurring during the execution of these SQL statements will normally terminate the reader or writer (depending on where the SQL statement is executed) with an error. If the specified statement is preceded by a hyphen (“-”), such errors are ignored.
This parameter allows for the execution of SQL statements after a set of tables has been read. For example, it may be necessary to clean up a temporary view after creating it.
For detailed information about SQL functions, click the corresponding menu item in the .
Available menu options depend on the format.
Multiple SQL commands can be delimited by a character specified using the FME_SQL_DELIMITER directive, embedded at the beginning of the SQL block. The single character following this directive will be used to split the SQL block into SQL statements, which will then be sent to the database for execution. Note: Include a space before the character.
For example:
FME_SQL_DELIMITER ; DELETE FROM instructors ; DELETE FROM people WHERE LastName='Doe' AND FirstName='John'
Multiple delimiters are not allowed and the delimiter character will be stripped before being sent to the database.
Any errors occurring during the execution of these SQL statements will normally terminate the reader or writer (depending on where the SQL statement is executed) with an error. If the specified statement is preceded by a hyphen (“-”), such errors are ignored.
Whether multiple geometry or aggregate features with one member are read as stored or simplified and read as single member. For example, if Yes, an aggregate of points or multipoint features with only one point will be returned as a simple point.

