Connection String Options
The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.
For more information on establishing a connection, see Establishing a Connection.
| Property | Description |
| AuthScheme | The type of authentication to use when connecting to Salesforce. |
| User | The Salesforce user account used to authenticate. |
| Password | The password used to authenticate the user. |
| SecurityToken | The security token used to authenticate access to the Salesforce account. |
| UseSandbox | A boolean determining if the connection should be made to a Salesforce sandbox account. |
| CredentialsLocation | The location of the settings file where token retrieved with OKTA MFA is saved. |
| Property | Description |
| APIVersion | The version of the Salesforce API used. |
| LoginURL | URL to the Salesforce server used for logging in. |
| Property | Description |
| SSOLoginURL | The identity provider's login URL. |
| SSOProperties | Additional properties required to connect to the identity provider in a semicolon-separated list. |
| SSOExchangeUrl | The url used for consuming the SAML response and exchanging it with Salesforce specific credentials. |
| Property | Description |
| UseBulkAPI | Whether to use the synchronous SOAP API or the asynchronous Bulk API. |
| BulkAPIConcurrencyMode | The concurrency mode for processing bulk rows with BULK API v1. |
| BulkPageSize | The number of records to retrieve before returning results to the user when UseBulkAPI=true. |
| BulkPollingInterval | The time interval in milliseconds between requests that check the availability of the bulk query response. The default value is 500 ms. |
| BulkQueryTimeout | The timeout in minutes for which the provider will wait for a bulk query response. The default value is 25 minutes. |
| WaitForBulkResults | Whether to wait for bulk results when using the asynchronous API. Only active when UseBulkAPI is true. |
| Property | Description |
| UseToolingAPI | Whether to use the Salesforce Tooling API. |
| Property | Description |
| InitiateOAuth | Set this property to initiate the process to obtain or refresh the OAuth access token when you connect. |
| OAuthClientId | The client Id assigned when you register your application with an OAuth authorization server. |
| OAuthClientSecret | The client secret assigned when you register your application with an OAuth authorization server. |
| OAuthAccessToken | The access token for connecting using OAuth. |
| OAuthSettingsLocation | The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH. Alternatively, this can be held in memory by specifying a value starting with memory://. |
| CallbackURL | The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings. |
| OAuthServerURL | The server URL to use if authenticating with OAuth. |
| OAuthGrantType | The grant type for the OAuth flow. |
| OAuthAuthorizationURL | The authorization URL for the OAuth service. |
| OAuthAccessTokenURL | The URL to retrieve the OAuth access token from. |
| OAuthVerifier | The verifier code returned from the OAuth authorization URL. |
| OAuthRefreshToken | The OAuth refresh token for the corresponding OAuth access token. |
| OAuthExpiresIn | The lifetime in seconds of the OAuth AccessToken. |
| OAuthTokenTimestamp | The Unix epoch timestamp in milliseconds when the current Access Token was created. |
| Property | Description |
| OAuthJWTCert | The JWT Certificate store. |
| OAuthJWTCertType | The type of key store containing the JWT Certificate. |
| OAuthJWTCertPassword | The password for the OAuth JWT certificate. |
| OAuthJWTCertSubject | The subject of the OAuth JWT certificate. |
| OAuthJWTIssuer | The issuer of the Java Web Token. |
| OAuthJWTSubject | The user subject for which the application is requesting delegated access. |
| Property | Description |
| SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| FirewallType | The protocol used by a proxy-based firewall. |
| FirewallServer | The name or IP address of a proxy-based firewall. |
| FirewallPort | The TCP port for a proxy-based firewall. |
| FirewallUser | The user name to use to authenticate with a proxy-based firewall. |
| FirewallPassword | A password used to authenticate to a proxy-based firewall. |
| Property | Description |
| ProxyAutoDetect | This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings. |
| ProxyServer | The hostname or IP address of a proxy to route HTTP traffic through. |
| ProxyPort | The TCP port the ProxyServer proxy is running on. |
| ProxyAuthScheme | The authentication type to use to authenticate to the ProxyServer proxy. |
| ProxyUser | A user name to be used to authenticate to the ProxyServer proxy. |
| ProxyPassword | A password to be used to authenticate to the ProxyServer proxy. |
| ProxySSLType | The SSL type to use when connecting to the ProxyServer proxy. |
| ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer . |
| Property | Description |
| Logfile | A filepath which designates the name and location of the log file. |
| Verbosity | The verbosity level that determines the amount of detail included in the log file. |
| LogModules | Core modules to be included in the log file. |
| MaxLogFileSize | A string specifying the maximum size in bytes for a log file (for example, 10 MB). |
| MaxLogFileCount | A string specifying the maximum file count of log files. |
| Property | Description |
| Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
| BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC. |
| Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC. |
| Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC. |
| Property | Description |
| AutoCache | Automatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider . |
| CacheDriver | The database driver used to cache data. |
| CacheConnection | The connection string for the cache database. This property is always used in conjunction with CacheProvider . Setting both properties will override the value set for CacheLocation for caching data. |
| CacheLocation | Specifies the path to the cache when caching to a file. |
| CacheTolerance | The tolerance for stale data in the cache specified in seconds when using AutoCache . |
| Offline | Use offline mode to get the data from the cache instead of the live source. |
| CacheMetadata | This property determines whether or not to cache the table metadata to a file store. |
| Property | Description |
| AllOrNone | A boolean indicating if you would like all inserts, updates, or deletes to fail in a request if even a single record fails. |
| ArchiveMode | Boolean indicating whether to include deleted and archived records with a standard SELECT query. |
| ConnectionLifeTime | The maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed. |
| ConnectOnOpen | This property specifies whether to connect to the Salesforce when the connection is opened. |
| ContinueOnAlterException | Whether you want to continue after a ALTER statement has failed. |
| ExposeConceptualEntities | Boolean determining if the Salesforce record types / conceptual entities should be exposed as tables. |
| FilterScope | Optional scope to limit the records returned from queries. |
| IncludeMetadataDescription | Set this property to a value other than NONE if you want to retrieve the descriptions for columns, tables or both of them from the Metadata API. |
| MaxRows | Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time. |
| Other | These hidden properties are used only in specific use cases. |
| PoolIdleTimeout | The allowed idle time for a connection before it is closed. |
| PoolMaxSize | The maximum connections in the pool. |
| PoolMinSize | The minimum number of connections in the pool. |
| PoolWaitTime | The max seconds to wait for an available connection. |
| PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
| QueryPassthrough | Whether to accept SOQL queries. |
| Readonly | You can use this property to enforce read-only access to Salesforce from the provider. |
| RemoveBOMCharacter | Specifies whether to remove the BOM character (char)0xfeff from the content. |
| ReplaceInvalidUTF8Chars | Specifies whether to replace invalid UTF8 characters with a '?'. |
| RTK | The runtime key used for licensing. |
| ServerSideAggregation | A boolean determining if server side aggregation should be used. |
| SessionTimeout | The time in minutes for which a Salesforce login session is reused. |
| SkipFormulaFields | Set to true if formula fields should be skipped when listing columns. |
| SortColumns | Set to true to sort table columns instead of reporting them in the Salesforce order. |
| Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
| UseConnectionPooling | This property enables connection pooling. |
| UseDisplayNames | Boolean determining if the display names for the columns should be used instead of the API names. |
| UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |