The following table lists the connection string parameters for Salesforce.
Parameter | Description |
---|---|
Authentication |
The authentication type to use when connecting to Salesforce. Defaults to OAuth.
OAuth
The OAuth 2.0 authentication.
User ID and Password
The basic user/password authentication.
|
Server |
The URL of the Salesforce server. Supported domains include salesforce.com, force.com, and database.com. Defaults to login.salesforce.com. |
User ID |
The Salesforce username. Available when the User ID and Password authentication type is selected. |
Password |
The Salesforce password. Available when the User ID and Password authentication type is selected. |
Security Token |
The security token used to authenticate access to your Salesforce account. Available when the User ID and Password authentication type is selected. To generate a token, login to Salesforce, click the User Menu in the top right corner, and select My Personal Information > Reset My Security Token. |
Refresh Token |
The Salesforce OAuth 2.0 token. Available when the OAuth 2.0 authentication type is selected. |
Proxy Settings |
|
Proxy Server |
The proxy hostname or IP address. |
Proxy Port |
The proxy port. |
Proxy User |
The proxy username. |
Proxy Password |
The proxy password. |
Advanced Settings |
|
Allow NULL strings |
To retrieve metadata, not all parameters according to MSDN can accept a null value. If NULL, the driver should return an error. But some 3rd-party tools pass NULL to the parameters. These options should be enabled for compatibility with such tools. |
Empty strings as NULL |
|
Cache Metadata |
This is a configurable parameter, which allows caching and storing metadata in a temporary database. The parameter settings specify the frequency of resetting cached metadata ranging from 1 hour...to 1 month.
False
The metadata caching is disabled.
Hour
Cached metadata is reset one time per hour.
Day
Cached metadata is reset once a day (i.e. every 24 hours).
Month
Cached metadata is reset once per month.
True
Metadata caching won't reset until the driver is unloaded.
|
Connection Timeout |
The time (in seconds) to wait for a connection to open before terminating an attempt. The default value is 60. |
Include Deleted |
Use the parameter to specify whether to include deleted records to the query results. The default value is False. |
ODBC Behavior |
Used to set the behavior corresponding to the ODBC specification version that a third-party tool expects. The behavior of ODBC driver can be changed by setting a value for the SQL_ATTR_ODBC_VERSION attribute by calling the SQLSetEnvAttr function. But some third-party tools expect the driver to exhibit ODBC 2.x behavior, but forget to call SQLSetEnvAttr with the specified version or pass an incorrect value there. In this case, the required behavior can be explicitly specified in the Connection String by setting the ODBC Behavior parameter. The possible values are:
|
RegionalNumberSettings |
Enables the use of local regional settings when converting numbers to strings. |
RegionalDateTimeSettings |
Enables the use of local regional settings when converting dates and times to strings. |
ReturnForeignKeys |
Use the option to specify whether the driver must return foreign keys. Retrieving metadata about foreign key constraints is a time-consuming operation; many third-party tools request foreign key metadata even whey they do not actually need this information. Note that enabling the option may degrade performance of data access operations. The default value is False. |
String Types |
Sets the string value types returned by the driver as Default, Ansi or Unicode.
The parameter value should be changed if any third-party tool supports only Ansi string types or Unicode ones. |
QueryTimeout |
The time to wait for a query execution result before terminating and generating an error. |
UTC Dates |
Specifies whether all the datetime values retrieved from the data source are returned as UTC values or converted to local time and whether the date values specified on the application side (e.g., in SQL statements) are considered UTC or local. The default value is false. |
DRIVER={Devart ODBC Driver for Salesforce};User ID=Your_Username;Password=******;Security Token=a6Lgob979LW4anxfbhtDgtukr |