Reader Directives: Enterprise Geodatabase Feature Classes
VERSION
Required/Optional: Optional, as long as either a transactional or historical version is provided
The version of the dataset to be read (used in multi-versioned databases). The version name must be prefixed by the owner of the version and a period.
Note: The version name is case-sensitive.
Parameter: <version>
Workbench Parameter: Transactional Version
Example:
GEODATABASE_SDE_VERSION jim.versionone
HISTORICAL_VERSION_NAME
Required/Optional: Optional, so long as either a transactional or historical version is provided
The historical marker name of the dataset to be read (used in multi-versioned databases that have archiving enabled).
Note: The version name is case-sensitive, and that historical data is read-only.
Parameter: <historical_version_name>
Workbench Parameter: Historical Marker
Example:
GEODATABASE_SDE_HISTORICAL_VERSION_NAME newmarker
HISTORICAL_VERSION_TIMESTAMP
Required/Optional
Optional, as long as either a transactional or historical version is provided
The specific date and time of the archived dataset to be read (used in multi-versioned databases that have archiving enabled).
Note: The date and time must be provided in the correct format for the underlying database (see ArcGIS help for more information), and that historical data is read-only.
Parameter: <historical_version_timestamp>
Workbench Parameter: Historical Timestamp
Example:
GEODATABASE_SDE_HISTORICAL_VERSION_TIMESTAMP "1/1/2006 12:00:01 AM"
CHILD_VERSION_NAME
Required/Optional: Optional
Parameter: <child_version_name>
Workbench Parameter: Child Version Name
Example:
GEODATABASE_SDE_CHILD_VERSION_NAME check_out
ARCHIVE_WHERE
Required/Optional: Optional
Workbench Parameter: Archive Where Clause
Example of a ‘moment’ query:
The following demonstrates an example of using the archive where clause to perform a ‘moment’ query, which will return all features existing in the database as of 9:00 am on May 1st, 2007
GEODATABASE_SDE_ARCHIVE_WHERE GDB_FROM_DATE <= 20070501090000 AND GDB_TO_DATE > 20070501090000
Example of a ‘range’ query:
The following demonstrates an example of using the archive where clause to perform a ‘range’ query, which will return all features inserted after 9:00 am on January 1st, 2007 and updated or deleted before 11:59 pm on December 31st, 2007
GEODATABASE_SDE_ARCHIVE_WHERE GDB_FROM_DATE > 20070101090000 AND GDB_TO_DATE < 20071231235959
PERSISTENT_CONNECTION
Required/Optional: Optional
Specifies whether to create a connection to SDE that persists and can be shared by other Geodatabase SDE Readers and Writers. When set to YES, the connection will remain open until FME shuts down, even if this reader is finished using it. Otherwise, the connection will be closed when the reader is shut down (unless another reader/writer is still using the connection).
Creating a new connection is an expensive operation. Depending on how FME is being used (that is, if there are multiple instances of the Geodatabase SDE Reader/Writer being used), the performance may improve by setting this directive to YES.
Value: YES | NO
Default Value: NO
Example:
GEODATABASE_SDE_PERSISTENT_CONNECTION YES
Workbench Parameter
Make Connection Persistent
COMPARE_TRANSACTIONAL_VERSION
Required/Optional: Optional, so long as either a transactional or historical version is provided when reading version differences.
The transactional name of the dataset whose common ancestor with the connection version will be used as the baseline for difference reading.
The version name is case-sensitive.
Workbench Parameter: Baseline Transactional Version
COMPARE_HISTORICAL_VERSION_NAME
Required/Optional: Optional, so long as either a transactional or historical version is provided when reading version differences.
The historical marker name of the dataset to be used as the baseline for difference reading (used in multi-versioned databases that have archiving enabled).
The version name is case-sensitive.
Workbench Parameter: Baseline Historical Marker
COMPARE_HISTORICAL_VERSION_TIMESTAMP
Required/Optional: Optional, so long as either a transactional or historical version is provided when reading version differences.
The specific date and time to be used as the baseline for difference reading.
The date and time must be provided in the correct format for the underlying database (see ArcGIS help for more information), and that historical data is read-only.
Workbench Parameter: Baseline Historical Timestamp
Example:
GEODATABASE_SDE_COMPARE_HISTORICAL_VERSION_TIMESTAMP "1/1/2006 12:00:01 AM"
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>
Note: 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
ALIAS_MODE
This directive allows the user to specify what kind of alias handling should be performed. See the Workbench Reader Parameters for more details.
Required/Optional
Optional
Parameter
<alias_mode>
Values
NONE (default) | SCHEMA | ON_DATA_FEATURES
Workbench Parameter
Alias Mode