Property | S/T | Description |
|---|---|---|
Encoding | S/T | Type of character encoding to use with source and target files. The default value is OEM. Shift-JIS encoding is used only in Japanese operating systems. UCS-2 is no longer considered a valid encoding name, but you may use UCS2. In the data file, change UCS-2 to UCS2. Note: This property is not encoding of the database that you connect to, but it is the encoding in which the connector expects to receive SQL query statements that must be sent to the database. |
WhereStmt | S | Provides a pass-through mechanism for SQL connectors where advanced users can construct the Where clause of the SQL query themselves. It can be used as an alternative to write a lengthy query statement. You may use this to instruct the SQL database server to filter the data based on a particular condition before sending it to the integration platform. There is no default value for this property. Note: This property is not applicable when the source connection is a query statement or file. This property enables data filtering when you select a table. |
SystemTables | S/T | If set to True, allows you to see all tables created by the DBA in the database. The system table names appear in the table list. The default value is False. Note: This property is applicable only if you have logged in to the database as the Database Administrator (DBA). Only the DBA has access to system tables. |
Views | S/T | If set to True, this property allows you to see the view names in the table list along with the table names. Default is True. Note: This property supports only Append and DeleteAndAppend output modes and does not support the Replace output mode. |
Synonyms | S/T | If set to True, allows you to see synonyms. The alias names appear in the table list along with the tables. Default is False. |
DSNType | S | Data sources or drivers to connect to in the Data Source Name (DSN) list. DSNs are listed in Control Panel > Administrative Tools > ODBC Data Source Administrator window. The options are: • User & System: This is the default option. • System: This DSN allows database access for any user of a particular computer. The System DSN are stored in the Windows registry. • User: This DSN allows database access for a single user on a single computer. Like the System DSN, the information is stored in the Windows registry. • Driver: The ODBC driver to connect to. This driver must be installed on your computer. • File: This DSN stores information required to connect to the desired data source in a text file with a .DSN extension (not in the Windows registry) and can be shared by users of different computers who have the same drivers installed. For more information, see Configuring ODBC Data Source. |
CursorType | S | Type of cursor to use for retrieving records from the source table. The options available are: • Dynamic • Static • Forward Only The default value is Forward Only. Note: If you select Dynamic or Static, sometimes you may not be able to view the data in the Data Browser. To resolve this, append SELECTLOOPS=N to the DriverOptions property and refresh the connection. |
DriverCompletion | S/T | Controls whether the driver prompts the user for information. • Prompt – Prompts for every individual bit of information. • Complete (default) – Prompts only for missing information. • Complete Required – Prompts only for information needed to complete a connection. • No Prompt – Does not prompt for any information. |
IdentifierQuotes | S/T | Quoted identifiers are used to parse the SQL statement and distinguish between columns and character data in SQL statements. All databases have quoted identifiers. In a SQL statement, you must enclose identifiers containing special characters or match keywords in identifier quote characters; (also known as delimited identifiers in SQL-92). For example, the Accounts Receivable identifier is quoted in the following SELECT statement: SELECT * FROM "Accounts Receivable" If you do not use identifier quotes, the parser assumes there are two tables, Accounts and Receivable and return a syntax error that they are not separated by a comma. IdentifierQuotes has four options: • Default • None • " • ‘ |
ModifyDriverOptions | S/T | Allows storing of the ODBC connection. Default is true. If set to false, prompts for connection information each time the transformation runs. |
DriverOptions | S/T | Default is empty for a new map. This property will be automatically populated with ODBC connect string upon successful connection. For ODBC connectors, the map saved database information in the Driver Option property with real values (not using macros) during the last successful connection. If you want to run the map with a different database server, you have to delete the value for Driver Option and use the correct macros for the connection information. The map repopulates the value of Driver Option when it successfully connects to the new database server. |
MaxDataLength | S/T | Maximum number of characters to write to a field. It is the maximum data length for long data types. The default value is 1 MB. You can change this value based on the available memory and target requirements. When this connector requests the column field size for these data types, it checks for a returned value greater than the MaxDataLength value. If the value is greater, then the MaxDataLength value is used. Some ODBC drivers have maximum data length limitations. If you choose an ODBC source or target connector and the default setting is not 1 MB, the integration platform sets the value for that particular ODBC driver. In this case, do not set the MaxDataLength property to a higher value. |
TransactionIsolation | S/T | Isolation level when reading from or writing to a database table with ODBC. The isolation levels are: • Read uncommitted - Permits P1, P2, and P3. • Read committed - Permits P2 and P3. Does not permit P1. • Repeatable read - Permits P3. Does not permit P1 and P2. • Serializable - Does not permit P1, P2 or P3. The default is serializable. The ANSI SQL 2 standard defines three specific ways in which serializability of a transaction may be violated: P1 (Dirty Read), P2 (Nonrepeatable Read), and P3 (Phantoms). For further details about TransactionIsolation levels, see the IBM DB2 Universal Database ODBC documentation. |
ConstraintDDL | T | Additional SQL data definition language statements that must be executed after the target table is created. This is similar to the support provided for SQL pass-through in the SQL import connectors. Each line must be a valid ODBC DDL statement. For example, you can have the following statements: CREATE UNIQUE INDEX index1 ON mytable (Field1 ASC) CREATE INDEX index2 ON mytable (Field2, Field3) These statements create two indices on the table mytable. The first statement does not allow duplicates and the index values are stored in ascending order. The second index is a compound index on fields Field2 and Field3. The ConstraintDDL is run only if the output mode is Replace for the target. If there are any errors, they are written to the error and event log file. An error during transformation displays the Transformation Error dialog. You can ignore the DDL errors and continue the transformation. ConstraintDDL also supports an escaping mechanism that allows you to specify DDL in the native SQL of the DBMS. Any statement preceded by an @ sign is sent directly to DBMS. The following is a DDL statement for creating a primary key for the table mytable: @CREATE INDEX pk_mytable ON mytable (Field1, Field2) WITH PRIMARY Some ODBC drivers do not support the SQL extensions required to create a primary key with the ODBC variant of the SQL CREATE statement. In these cases, to create primary keys, use native SQL. |
CommitFrequency | T | Allows you to control how often data is committed to the database when the AutoCommit property is set to False. The default value is zero that is, the data is committed at the end of the transformation, allowing rollback on error. This is the slowest setting. When performing large transformations, this is not practical as it may produce too many transaction log entries. Specifying a nonzero value indicates that data is committed to the database after inserting or updating specified number of records. |
BulkOperations | T | Determines if an insert statement is run for each record or a bulk add is executed for each record. The default is False, the slower setting. If you want to maximize speed and instruct the integration platform to use a bulk add, change this setting to True. Use bulk operations for faster insert. |
PrimaryKey | T | List of field names that are used to create the primary key. Field names are delimited by commas. If the PrimaryKey property contains one or more field names, these names are included in the SQL CREATE statement when the connector is in Replace mode. To use the PrimaryKey property, the ODBC driver must support Integrity Enhancement Facility (IEF). Only advanced ODBC drivers support this. |
UseCursors | T | If set to True and the specified ODBC driver does not support cursor inserts, the integration platform falls back on the SQL INSERT mode of adding records. The default value is False. For exports, cursor support is meant to enhance the performance of inserting records. This is applicable for desktop databases. For database servers, there is no noticeable change in insert speed. Another complication of cursor inserts is that some drivers require the target table be indexed, otherwise positioned updates (cursors) are not allowed. The PrimaryKey and ConstraintDDL properties in the ODBC export connector addresses this issue. |
ArraySize | T | Determines the number of rows to be sent to the server at one time. The default value is 1000, meaning each row is individually sent to the server. Larger values will buffer multiple rows and send them all at once. While this improves the speed, it affects error reporting (a server error won't be detected/reported until the next batch of records is sent to the server). The maximum value allowed for this property is 100000. While the connector allows the value to be set that high, many drivers have lower limits. The connector will log a message indicating if the driver is forcing a lower value for the array size. In addition, the connector does not support arrays when there is a LOB-type field in the table, or when the (maximum) length of a character-type field is longer than 32767 characters. In these cases, a message will be logged indicating the array size has been reduced to 1. Due to the way the connector attempts to support older drivers, the array support requires BulkOperations and UseCursors is set to True or both must be set to False. If BulkOperations is False and UseCursors is True, then the array size is ignored and a message is logged indicating this condition. |