JDBC Reader Parameters

Database Connections

Connections store authentication information. For general information about sharing database connections, please see Using Database Connections.

Note: Depending on context and/or database format, you might see different combinations of Database Connection parameters.

ClosedConnection

Select an existing connection, or Add Database Connection to define a new connection.

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

Connection Parameters

ClosedJDBC Connection String

The connection string for the database to which you are connecting. The precise format depends on the JDBC driver being used, but a connection string will always start with:

jdbc:<subprotocol>:

See the FME Knowledge Center for information about the compatibility of various JDBC drivers with FME, and to view Workbench examples.

ClosedUsername and Password

If not specified in the JDBC Connection String, enter the username and password to access the database.

ClosedJava Driver Class

This parameter is not required for well-behaved JDBC 4.0+ drivers.

For drivers that do not self-register, enter the name of the Java class for the desired driver .

Note: When errors are being returned by the wrong JDBC driver, specifying the Driver Class can force the connection string to be processed by only the desired driver.

ClosedConnection Property and Value

JDBC connections can be configured with driver-specific arbitrary name/value pairs. The name/value pairs can often be specified in either the Connection String or a Properties object (sometimes only in one way or the other).

Name/value pairs entered here will be set in the order specified, then passed on in a Properties object. They do not require manual encoding of characters that are not safe in Connection Strings.

ClosedQuery Timeout (Seconds)

This parameter defines the time, in seconds, after which a query will be terminated if it has not yet returned a result.

If set to zero, there is no timeout. The default is 30.

Note: If this value is not set high enough, then the query will return the error Provider Error - Timeout Expired.

Constraints

ClosedTable List

After you have completely specified the database connection, click the Browse button to select tables to import. A connection window appears while FME reads 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 Reader Parameters box.

Schema Attributes

ClosedAdditional Attributes to Expose

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, you can use this parameter to expose additional attributes on multiple feature types.

Advanced

ClosedSQL to Run Before Read

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 SQL to Run editor helpClosed.

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.

ClosedSQL To Run After Read

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 SQL to Run editor helpClosed.

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.