The suffixes listed are prefixed by the current <ReaderKeyword> in a mapping file. By default, the <ReaderKeyword> for the Teradata reader is TERADATA_SPATIAL_IN.
DATASET
This directive specifies the name of the Teradata Database. The database name must exist in the DBMS.
Required/Optional
Required
Mapping File Syntax
TERADATA_SPATIAL_DATASET dbc
Workbench Parameter
Source Teradata Spatial Dataset
HOST
This directive specifies the hostname of the machine hosting the DBMS.
Required/Optional
Required
Mapping File Syntax
TERADATA_SPATIAL_HOST 127.0.0.1
Workbench Parameter
Host
USER_NAME
The name of user who will access the database. The named user must exist with appropriate permissions.
Required/Optional
Required
Mapping File Syntax
TERADATA_SPATIAL_USER_NAME dbc
Workbench Parameter
Username
PASSWORD
The password of the user accessing the database.
Required/Optional
Optional
Mapping File Syntax
TERADATA_SPATIAL_PASSWORD secret
Workbench Parameter
Password
DEF
The syntax of the definition is:
TERADATA_SPATIAL_DEF <tableName> \
[<fieldName> <fieldType>] +
The <tableName> must match the name of an existing Teradata table in the database. This will be used as the feature type of all the features read from the table.
The <fieldType> of each field must be given, but it is not verified against the database definition for the field. In effect, it is ignored. The exception to this is the geometry field type, which is not placed in the DEF.
The following example selects rows from the table ROADS, placing the resulting data into FME features with a feature type of ROADS:
TERADATA_SPATIAL_DEF ROADS
Required/Optional
Required
WHERE_CLAUSE
This optional specification is used to specify a WHERE clause to use for the query.
If no <whereClause> is specified, all rows in the table will be read and returned as individual features. If a <whereClause> is specified, only those rows that are selected by the clause will be read.
Note that the <whereClause> does not include the word WHERE.
Required/Optional
Optional
Mapping File Syntax
The example below selects only the rows for which the name column value is equal to safe:
TERADATA_SPATIAL_IN_WHERE_CLAUSE name=’safe’
Workbench Parameter
WHERE Clause
IDs
This optional specification is used to limit the available and defined database tables files that will be read.
If no IDs are specified, then all defined and available tables are read.
Required/Optional
Optional
Mapping File Syntax
TERADATA_SPATIAL_IDs <featureType1> \
<featureType2> \
<featureTypeN>
The feature types must match those used in DEF lines.
The example below selects only the ROADS table for input during a translation:
TERADATA_SPATIAL_IDs ROADS
SEARCH_ENVELOPE
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 interact with the bounding box are returned.
If all four coordinates of the search envelope are specified as 0, the search envelope will be disabled.
Mapping File Syntax
<ReaderKeyword>_SEARCH_ENVELOPE <minX> <minY> <maxX> <maxY>
If all four coordinates of the search envelope are specified as zero, the search envelope will be disabled.
Required/Optional
Optional
Workbench Parameter
Minimum X, Minimum Y, Maximum X, Maximum Y
SEARCH_ENVELOPE_COORDINATE_SYSTEM
This directive specifies the coordinate system of the search envelope if it is different than the coordinate system of the data.
The COORDINATE_SYSTEM directive, which specifies the coordinate system associated with the data to be read, must always be set if the SEARCH_ENVELOPE_COORDINATE_SYSTEM directive is set.
If this directive is set, the minimum and maximum points of the search envelope are reprojected from the SEARCH_ENVELOPE_COORDINATE_SYSTEM to the reader COORDINATE_SYSTEM prior to applying the envelope.
Required/Optional
Optional
Mapping File Syntax
<ReaderKeyword>_SEARCH_ENVELOPE_COORDINATE_SYSTEM <coordinate system>
Workbench Parameter
Search Envelope Coordinate System
CLIP_TO_ENVELOPE
This directive specifies whether or not FME should clip features to the envelope specified in the SEARCH_ENVELOPE directive.
Values
YES | NO (default)
Mapping File Syntax
<ReaderKeyword>_CLIP_TO_ENVELOPE [yes | no]
Workbench Parameter
Clip To Envelope
RETRIEVE_ALL_TABLE_NAMES
This parameter is only applicable when generating a mapping file, generating a workspace or when retrieving schemas in an FME Objects application.
When set to yes, and if RETRIEVE_ALL_SCHEMAS is set to no (or missing), names for all of the tables and feature classes in the database are returned. When set to no (or missing), and if RETRIEVE_ALL_SCHEMAS is similarly set to no (or missing), the schemas requested by the IDs directive are returned.
If RETRIEVE_ALL_SCHEMAS is also set to Yes, then RETRIEVE_ALL_SCHEMAS takes precedence.
Required/Optional
Optional
Values
YES | NO (default)
Mapping File Syntax
Not applicable.
FME Objects applications would include RETRIEVE_ALL_TABLE_NAMES followed by “YES” in the parameters array passed to IFMEUniversalReader::open().
Workbench Parameter
Not applicable (used when you browse a Table List)
HOMOGENEOUS_GEOMETRY
This specification is only applicable when generating a mapping file, generating a workspace, or when retrieving schemas in an FME Objects application.
Required/Optional
Optional
Values
YES | NO (default)
This optional specification may be set to Yes to tell the reader to read the first feature of the dataset during the schema read. The geometry type of the first feature will be the only type reported as supported in the schema. If this value is not specified, then it is assumed to be No.
Results will be unpredictable if this value is set to Yes for a heterogeneous dataset.
EXPOSED_ATTRS
This directive allows the selection of format attributes to be explicitly added to the reader feature type.
This is similar to exposing format attributes on a reader feature type once it has been generated; however, it is even more powerful because it enables schema-driven applications other than Workbench to access and leverage these attributes as if they were explicitly on the schema as user attributes.
The result of picking a list of attributes is a comma-separated list of attribute names and types that will be added to the schema features. Currently all reader feature types will receive the same set of additional schema attributes for a given instance of the reader.
Required/Optional
Optional
Mapping File Syntax
Not applicable.
While it is possible for FME Objects applications to invoke this directive, the required format is not documented.
This directive is intended for use in our GUI applications (for example, Workbench) only.
Workbench Parameter
Additional Attributes to Expose