ODBC Connector Properties
The following table defines the properties for the Connector for ODBC.
Token |
Name/Description |
Type |
---|---|---|
LCTOKEN_SERVER |
Server Name of the ODBC data source as listed in the ODBC Administrator |
Text |
LCTOKEN_USERID |
Userid User ID/name: used for logging in during connection |
Text |
LCTOKEN_PASSWORD |
Password Password: used for logging in during connection |
Text |
LCTOKEN_METADATA |
Metadata Data table source or target for data transfer operations |
Text |
LCTOKEN_INDEX |
Index Data index name. |
Text |
LCTOKEN_MAP_NAME |
MapByName Whether to map by name or position when transferring data between data source and target. |
Boolean |
LCTOKEN_WRITEBACK |
Writeback Whether to perform writeback or non-writeback operations. |
Boolean |
LCTOKEN_FIELDNAMES |
FieldNames Text list of fields to select -- used for Select operations |
Text List |
LCTOKEN_ORDERNAMES |
OrderNames Text list of fields to order results by -- used for Select operations |
Text List |
LCTOKEN_CONDITION |
Condition Connector-specific syntax conditional clause -- used for Select operations |
Text |
LCTOKEN_STAMPFIELD |
StampField Name of timestamp field used for Select operations |
Text |
LCTOKEN_BASESTAMP |
BaseStamp Minimum timestamp value to include in results -- used for Select operations |
Datetime |
LCTOKEN_MAXSTAMP |
MaxStamp During a Select operations, set by the connector to the current timestamp value - set by Select operations |
Datetime |
LCTOKEN_ OWNER |
Owner Only objects owned by the owner name in this property are included in the result set |
Text |
LCTOKEN_ALT_METADATA |
Affects the behavior of METADATA and FIELD catalog types, returning a list of objects of the alternate metadata type instead of the normal metadata type. |
Boolean |
LCTOKEN_CONNECT_TIMEOUT |
Maximum number of seconds to wait for a successful connection (the default value of zero indicates to use that connector's default settings). |
Integer |
LCTOKEN_RECORD_LIMIT |
Result sets produced should be limited to this many records. A value of zero (the default) indicates no limit. |
Integer |
1.00 |
CommitFrequency Number of data modification actions between commits. A value of zero causes a commit at disconnect; a value of one auto-commits after every action; any other value commits after that many data modification actions. |
Integer |
2.00 |
RollbackOnError Whether to rollback the current transaction at disconnection if the session is in an error state. |
Boolean |
3.00 |
DisableCursor Whether to force disabling of ODBC cursors. This option reduced performance, and should be used only during writeback operations when the ODBC driver inaccurately reports cursor support, resulting in an error. |
Boolean |
4.00 |
QuoteColumn String used to surround column names (for example ") |
Text |
5.00 |
DBMSName Read-only name of the DBMS target of the ODBC connection |
Text |
6.00 |
TraceSQL Select this option to include all SQL statements generated during the execution of the activity in the activity's log. This can be helpful when you need to troubleshoot the activity. |
Boolean |
7.00 |
SingleThread By default, the Connector for ODBC is multi-threaded. However, some ODBC drivers are not multi-threaded. Use this property to force the connector into a single thread. |
Boolean |