Oracle Spatial Object Reader Parameters

This parameter specifies a database connection for the reader through a drop-down menu. The Add Database Connection option in the menu allows you to create a new connection. The connection requires a name that describes the connection.

Note: The following characters are not allowed in connection names: ^ \ / : * ? " < > | & = ' + % #

The new connection can be made visible only to the current user, or can be shared among multiple users.

Specifies the Oracle database to connect to. This may be a Net Service Name defined in tnsnames.ora or an Easy Connection Identifier. Either form of connection identifier may be prefixed with username and password information.

[<username>[/<password>]@][//]<hostname>[:<port>]/<service_name>.

[<username>[/<password>]@]<net_service_name>

The username and password.

The name of the Oracle Workspace Manager workspace that will be used by the reader. All tables will be read using the same workspace. If this parameter is omitted, or left blank, the default LIVE workspace will be used.

If this parameter is selected (default), the Oracle database connection remains open for other requestors. A persistent connection is useful for workspaces that are long-running, or published using FME Server.

If this parameter is deselected, the connection to the Oracle database is closed as soon as possible after data processing is complete.

If selected or set to Yes, the Table List (in the reader parameters dialog and in the parameter dialog for Feature Types to Read), and the Merge Filter parameter in the reader feature types dialog will include tables that live in system schemas or which contain special characters like / and $.

If deselected or set to No, the Table List and the Merge Filter will not include system tables or tables with special characters.

Note that recycled tables (names starting with BIN$) will never be included.

Specifies whether to keep the table qualifier. The full name of a table in a database is of the format:

<prefix>.<table_name>

Depending on the database format, the prefix can be <database_name>.<owner_name>, <owner_name>, or <schema_name>.

Selecting this parameter indicates that the reader should return the table name without any prefixes. This is useful, for example, when creating a workspace that will be passed on to another organization using the same table names, or performing a translation to another database format but with a different user name.

When this parameter is selected during workspace generation, the source feature types will be the table names without any prefix; otherwise, they will contain the owner name as a prefix. It is recommended that you do not change this parameter after generating the workspace, because it is possible for no features to be successfully passed onto the writer (since the writer is expecting feature types with different names).

Note: Even when this parameter is selected, if the table is owned by a user other than the current user, the prefix will not be dropped. This is to ensure that the reader will find the correct table.

Controls whether 3D polygons are read by the Oracle Spatial Object reader as 3D face geometries or as regular polygons.

After you have specified the database connection, click the Browse button to select tables for import. A connection window appears while the system compiles a table from the database.

Once the table list appears, you can select one or more tables, and then click OK to dismiss the window. The table name(s) will appear in the Table List field in the parameter box.

Enter any SQL where clause that constrains the attributes of the layers selected in the layer list (for example, NUMLANES=2).

Checking this box allows the reader to parse MapInfo style and index columns.

This optional generation parameter specifies the name of the MapInfo symbology style column. If a column by this name is found, it will be omitted from the schema of the generated source feature type, and the parameter will be set to the name of this column.

This optional generation parameter specifies the name of the MapInfo symbology index column. If a column by this name is found, it will be omitted from the schema of the generated source feature type.

Use this parameter to expose Format Attributes in 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 where you have multiple feature types, it is convenient to expose additional attributes using this one parameter. For example, if you have ten feature types and want to expose the same attribute in each one, it is easier to define it once than it is to set each feature type individually in the workspace.

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.

If all four coordinates of the search envelope are specified as 0, the search envelope will be disabled.

Select this parameter to remove any portions of imported features being read that are outside the Search Envelope.

The illustration below shows the results of the Search Envelope when Clip to Search Envelope is set to No on the left side and Yes on the right side.

• No: Any features that cross the search envelope boundary will be read, including the portion that lies outside of the boundary.
• Yes: Any features that cross the search envelope boundary will be clipped at the boundary, and only the portion that lies inside the boundary will be read. The underlying function for the Clip to Search Envelope function is an intersection; however, when Clip to Search Envelope is set to Yes, a clipping operation is also performed in addition to the intersection.

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.

Rows are read from the Oracle database using a bulk reading technique to maximize performance.

This parameter allows you to tune the performance of the reader by specifying how many rows are read from the database at a time.

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.

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.

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.

If this parameter is set to Yes, feature geometry will be read into an aggregate.

A parameter is set on the aggregate to indicate that each part of the aggregate is independent from the others, and its own geometry. Geometry parts of the aggregate are named and contain geometry according to their respective column in the table being read.

If a geometry is read as null, it will be appended to the aggregate as a null geometry. Geometry-specific data normally added to the feature as attributes will be added as traits to the geometry instead.

Note: When using this feature, neither the geometry column, nor the feature type SELECT statement can be specified. Also, tables with topology columns will not be read in this mode.

This parameter specifies the type of relationship which must exist between the search envelope and the geometry in the target layer. Any supported relationship, or combination of relationships, may be specified.

This table lists the valid geometry interaction relationships.

In addition to specifying a single relationship, one may specify a combination of relationships to be tested by concatenating them with a plus sign (+). For example, the parameter may be specified as INSIDE + TOUCH.

This specifies the test that is applied to the results of the above geometry relationship comparison. When using the object model, Spatial queries return results of TRUE rather than the name of the interaction – as they do with the older relational model – so the default test for the object model is “= ‘TRUE’”, regardless of the type of interaction involved.