Help > ODBC Drivers > Salesforce Driver > Connection String Attributes

Introduction

This page lists all possible attributes you can use in ConnectionString or WITH clause of SQL Query. If you are not sure how to write correct connection string then perform following steps.

1. Search for odbcad32 in the start menu. Click to launch it.
2. Configure desired properties in the grid and check Query Preview to make sure everything is correct.
3. Click on [Copy Connection String] button to generate full connection string.

Connection String Examples

Syntax: (Direct Connection string without DSN)

Driver={ZappySys Salesforce Driver}[,Attribute1=Value;][,Attribute2=Value;]........[,Attribute3=Value;] 

Syntax: (Using DSN)

DSN=YourDsnName;[,Attribute1=Value;][,Attribute2=Value;]........[,Attribute3=Value;]

Connection String Attributes

Attribute	Label	Description
ConnectionStringFile (Setting of SalesforceConfigurationParams)	ConnectionStringFile
Cache Settings
CacheEntryTtl (Setting of SalesforceConfigurationParams)	Cache entry lifetime, sec	This property indicates how many seconds data is kept in cache (in case caching is enabled)
CacheFileLocation (Setting of SalesforceConfigurationParams)	Cache file location	This property allows you to set cache file location (you have to set Cache persistence mode to Storage)
CacheStorage (Setting of SalesforceConfigurationParams)	Cache storage	Specifies cache storage - in-memory only or local data file Available Options Option Description Memory Memory File File
CachingMode (Setting of SalesforceConfigurationParams)	Cache mode	Enables or disables cache usage for metadata / data Available Options Option Description Disabled Caching disabled Metadata Cache metadata All Cache all
Error Handling Settings
ConvErrorHandlingMode (Setting of SalesforceConfigurationParams)	Error handling for data conversion	Determines whether some data conversion errors are ignored or stop query processing. Available Options Option Description ThrowError Stop execution on data conversion error Ignore Ignore data conversion errors
Log Settings
LoggingLevel (Setting of SalesforceConfigurationParams)	Log level	Sets level of messages logged Available Options Option Description None None Error Error Debug Debug Info Info
LogPath (Setting of SalesforceConfigurationParams)	Log file location	Sets location for the log file (empty value means no log written)
LogSize (Setting of SalesforceConfigurationParams)	Maximum log file size (Mb)	Sets limit for log file size (0 means no limit, old log entries will be discarded if size limit is reached)
GroupName (Setting of ColumnsMetadata)	Group name
OverrideMode (Setting of ColumnsMetadata)	OverrideMode
Metadata Settings
TreatBlankBoolAsNull (Setting of SalesforceConfigurationParams)	Treat blank BOOLEAN value as NULL
TreatBlankDateAsNull (Setting of SalesforceConfigurationParams)	Treat blank DATE/TIME value as NULL
TreatBlankNumberAsNull (Setting of SalesforceConfigurationParams)	Treat blank NUMERIC value as NULL
Output Settings
DefaultRowLimit (Setting of SalesforceConfigurationParams)	Default data row limit (i.e. LIMIT / TOP clause)	Use this option if you like to limit number of rows fetched by any query. If you use LIMIT clause in the query then this option is ignored.
IncludeDeleted (Setting of SalesforceConfigurationParams)	Include Deleted Rows in the Output for SELECT	Use this flag to include deleted records in SELECT query that have been deleted because of a merge or delete. Basically this flag invokes queryAll() API rather query(). With this flag you will see other records along with deleted records where isDeleted is true.
OutputOption (Setting of SalesforceConfigurationParams)	Default Output Option for Insert/Update/Delete	By default Output=1 for WITH clause in INSERT/UPDATE/DELETE when not specified. Use this option to control default option. This is useful when ODBC Bulk INSERT invoked by some ETL Tools where you cannot supply WITH clause and like to mimic Output=0 so some errors are thrown if some insert records failed. By default when Output=1 then errors not thrown rather displayed in the output as rows.
Query Engine Temp Storage
TempStorageMode (Setting of SalesforceConfigurationParams)	Intermediate results storage	Use [Disk] if number of resulting rows or row data size is large Available Options Option Description Memory Memory Disk Disk
CertificatePassword (Setting of ClientCertificateInfo)	CertificatePassword
CertificatePath (Setting of ClientCertificateInfo)	CertificatePath
DisplayPath (Setting of ClientCertificateInfo)	DisplayPath
EnableCertificate (Setting of ClientCertificateInfo)	EnableCertificate
IgnoreValidationErrors (Setting of ClientCertificateInfo)	IgnoreValidationErrors
IsServiceAccount (Setting of ClientCertificateInfo)	IsServiceAccount
StorageType (Setting of ClientCertificateInfo)	StorageType	Available Options Option Description NotSet <Not set> LocalMachine Stored in LocalMachine Storage Area CurrentUser Stored in User Storage Area PfxFile Disk File - PFX (PKCS12) format
StoreName (Setting of ClientCertificateInfo)	StoreName	Available Options Option Description NotSet <Not set> AddressBook AddressBook AuthRoot AuthRoot CertificateAuthority CertificateAuthority Disallowed Disallowed My My Root Root TrustedPeople TrustedPeople TrustedPublisher TrustedPublisher
Thumbprint (Setting of ClientCertificateInfo)	Thumbprint
LogLevel (Setting of ILogger)	LogLevel	Available Options Option Description Normal Normal Summary Summary Detail Detail Debugging Debugging Disabled Disabled
PrefixTimestamp (Setting of ILogger)	PrefixTimestamp
DoNotUseDefaultProxy (Setting of ProxyInfo)	DoNotUseDefaultProxy
EnableProxy (Setting of ProxyInfo)	EnableProxy
ProxyAuthMode (Setting of ProxyInfo)	ProxyAuthMode	Available Options Option Description Basic Basic Ntlm Ntlm Digest Digest
ProxyDomain (Setting of ProxyInfo)	ProxyDomain
ProxyHost (Setting of ProxyInfo)	ProxyHost
ProxyPassword (Setting of ProxyInfo)	ProxyPassword
ProxyPort (Setting of ProxyInfo)	ProxyPort
ProxyType (Setting of ProxyInfo)	ProxyType	Available Options Option Description None None Socks4 Socks4 Socks4a Socks4a Socks5 Socks5 HttpConnect HttpConnect
ProxyUrl (Setting of ProxyInfo)	ProxyUrl
ProxyUseCreds (Setting of ProxyInfo)	ProxyUseCreds
ProxyUser (Setting of ProxyInfo)	ProxyUser
MaxRetryCount (Setting of RetryInfo)	MaxRetryCount
MessageListToHandle (Setting of RetryInfo)	MessageListToHandle
MultiplyWaitTimeForEachAttempt (Setting of RetryInfo)	MultiplyWaitTimeForEachAttempt
RetryMode (Setting of RetryInfo)	RetryMode	Available Options Option Description None Do not retry RetryAny Retry any web errors RetryWhenStatusCodeMatch Retry for matching response status code(s) RetryWhenMessageMatch Retry errors for matching error sub string(s)
StatusCodeListToHandle (Setting of RetryInfo)	StatusCodeListToHandle
WaitTimeMs (Setting of RetryInfo)	WaitTimeMs
AccessToken (Setting of SalesforceConnection)	AccessToken
AllOrNone (Setting of SalesforceConnection)	AllOrNone
AllowFieldTruncation (Setting of SalesforceConnection)	AllowFieldTruncation
AllowSaveOnDuplicates (Setting of SalesforceConnection)	AllowSaveOnDuplicates
ApiVersion (Setting of SalesforceConnection)	ApiVersion
AuthScheme (Setting of SalesforceConnection)	AuthScheme
AuthType (Setting of SalesforceConnection)	AuthType	Available Options Option Description Default User Id / Password OAuth OAuth 2.0 (Useful when 2FA / MFA enabled)
AuthUrl (Setting of SalesforceConnection)	AuthUrl
ClientId (Setting of SalesforceConnection)	ClientId
ClientSecret (Setting of SalesforceConnection)	ClientSecret
ConnectionString (Setting of SalesforceConnection)	ConnectionString
ConnectionStringFile (Setting of SalesforceConnection)	ConnectionStringFile
ConnectionStringFull (Setting of SalesforceConnection)	ConnectionStringFull
ConnectionStringNonDefaultsOnly (Setting of SalesforceConnection)	ConnectionStringNonDefaultsOnly
ConnectionStringNonDefaultsOnlyFull (Setting of SalesforceConnection)	ConnectionStringNonDefaultsOnlyFull
DisableCustomUrl (Setting of SalesforceConnection)	DisableCustomUrl
DisableSockProxySupport (Setting of SalesforceConnection)	DisableSockProxySupport
DisableTest (Setting of SalesforceConnection)	DisableTest
DisableThirdPartWebRequest (Setting of SalesforceConnection)	DisableThirdPartWebRequest
Domain (Setting of SalesforceConnection)	Domain
EnablePkceCodeVerifier (Setting of SalesforceConnection)	EnablePkceCodeVerifier
HasEnableProxyOption (Setting of SalesforceConnection)	HasEnableProxyOption
InstanceUrl (Setting of SalesforceConnection)	InstanceUrl
MetaBody (Setting of SalesforceConnection)	MetaBody
MetaContentType (Setting of SalesforceConnection)	MetaContentType	Available Options Option Description None None Json Json Xml Xml Regex Regex
MetaFields (Setting of SalesforceConnection)	MetaFields
MetaFilters (Setting of SalesforceConnection)	MetaFilters
MetaHeaders (Setting of SalesforceConnection)	MetaHeaders
MetaMethod (Setting of SalesforceConnection)	MetaMethod
MetaTemplate (Setting of SalesforceConnection)	MetaTemplate
MetaUrl (Setting of SalesforceConnection)	MetaUrl
OwnerChangeOptions (Setting of SalesforceConnection)	OwnerChangeOptions
Password (Setting of SalesforceConnection)	Password
PreferProxyUrl (Setting of SalesforceConnection)	PreferProxyUrl
RedirectUrl (Setting of SalesforceConnection)	RedirectUrl
RefreshToken (Setting of SalesforceConnection)	RefreshToken
RetainSameConnection (Setting of SalesforceConnection)	RetainSameConnection
RetryCountMax (Setting of SalesforceConnection)	RetryCountMax
RetryMessageList (Setting of SalesforceConnection)	RetryMessageList
RetryMode (Setting of SalesforceConnection)	RetryMode	Available Options Option Description None Do not retry RetryAny Retry any web errors RetryWhenStatusCodeMatch Retry for matching response status code(s) RetryWhenMessageMatch Retry errors for matching error sub string(s)
RetryMultiplyWaitTime (Setting of SalesforceConnection)	RetryMultiplyWaitTime
RetryStatusCodeList (Setting of SalesforceConnection)	RetryStatusCodeList
RetryWaitTimeMs (Setting of SalesforceConnection)	RetryWaitTimeMs
Scopes (Setting of SalesforceConnection)	Scopes
SecurityToken (Setting of SalesforceConnection)	SecurityToken
ServiceType (Setting of SalesforceConnection)	ServiceType	Available Options Option Description Production Production Sandbox Sandbox Other Other
ServiceUrl (Setting of SalesforceConnection)	ServiceUrl
SslVersion (Setting of SalesforceConnection)	SslVersion	Available Options Option Description Default System Default Ssl3 SSL v3.0 Ssl3Plus SSL v3.0 or higher Tls TLS v1.0 TlsPlus TLS v1.0 or higher Tls11 TLS v1.1 Tls11Plus TLS v1.1 or higher Tls12 TLS v1.2 Tls12Plus TLS v1.2 or higher Tls13 TLS v1.3 Any Any Version
SupportDualProxyMode (Setting of SalesforceConnection)	SupportDualProxyMode
Timeout (Setting of SalesforceConnection)	Timeout
TimeoutInMiliseconds (Setting of SalesforceConnection)	TimeoutInMiliseconds
TokenUrl (Setting of SalesforceConnection)	TokenUrl
Url (Setting of SalesforceConnection)	Url
UseIntegratedAuth (Setting of SalesforceConnection)	UseIntegratedAuth
UserName (Setting of SalesforceConnection)	UserName
UseThirdPartyWebRequest (Setting of SalesforceConnection)	UseThirdPartyWebRequest
UseWebProxy (Setting of SalesforceConnection)	UseWebProxy

---

Copyrights reserved. ZappySys LLC.