dotConnect for Salesforce Documentation
Devart.Data.Salesforce Namespace / SalesforceConnectionStringBuilder Class
Properties Methods

In This Topic
    SalesforceConnectionStringBuilder Class Members
    In This Topic

    The following tables list the members exposed by SalesforceConnectionStringBuilder.

    Public Constructors
     NameDescription
    Public ConstructorSalesforceConnectionStringBuilder ConstructorOverloaded. Initializes a new instance of the SalesforceConnectionStringBuilder class.  
    Top
    Public Properties
     NameDescription
    Public PropertyAuthenticationDetermines the authentication method to use when connecting to Salesforce.  
    Public PropertyBatchSizeGets or sets the number of records returned by a service at once. The default value is 500; the minimum is 200, and the maximum is 2,000.  
    Public PropertyCacheAllDetermines whether to cache data from all the Salesforce tables.  
    Public PropertyClientIdGets or sets the Consumer Key from the connected app definition.  
    Public PropertyClientSecretGets or sets the Consumer Secret from the connected app definition.  
    Public PropertyConnectionLifetimeGets or sets time span in seconds for connection to live. (Inherited from Devart.Data.SqlShimConnectionStringBuilder)
    Public PropertyConnectionString (Inherited from System.Data.Common.DbConnectionStringBuilder)
    Public PropertyConnectionTimeoutGets or sets the time to wait while trying to establish a connection before terminating the attempt and generating an error. (Inherited from Devart.Data.SqlShimConnectionStringBuilder)
    Public PropertyCount (Inherited from System.Data.Common.DbConnectionStringBuilder)
    Public PropertyDataCacheGets or sets the path to the data cache database file. If not set, the file is located in the user Application Data directory by default and is named by the Salesforce.com or Database.com account name.  
    Public PropertyDefaultCommandTimeoutGets or sets the time in seconds to wait while trying to execute a command before terminating the attempt and generating an error. (Inherited from Devart.Data.SqlShimConnectionStringBuilder)
    Public PropertyDefaultRefreshIntervalGets or sets the default refresh interval in seconds for refreshing data in cache. The default value is 3600 (one hour)  
    Public PropertyDeferredLoginDetermines whether to delay establishing an actual connection to Salesforce until some data that is not present in the local cache is queried or data is modified.  
    Public PropertyFailoverRetriesGets or sets the number of retry attempts to re-run a command in case when the command failed because of an exception, that indicates that the reason of the failure may be temporary. (Inherited from Devart.Data.SqlShimConnectionStringBuilder)
    Public PropertyHostGets or sets the Salesforce.com or Database.com login URL  
    Public PropertyIgnoreBlankValues  
    Public PropertyIncludeDeletedDetermines whether to include the deleted records (from Salesforce recycled bin) to SELECT query results.  
    Public PropertyInitializationCommandSpecifies a data source-specific command that should be executed immediately after establishing the connection. (Inherited from Devart.Common.DbConnectionStringBuilder)
    Public PropertyIsFixedSizeReturns true. (Inherited from Devart.Data.SqlShimConnectionStringBuilder)
    Public PropertyIsReadOnly (Inherited from System.Data.Common.DbConnectionStringBuilder)
    Public PropertyItemReturns the value of given key. (Inherited from Devart.Data.SqlShimConnectionStringBuilder)
    Public PropertyKeysCollection of keys in the Devart.Data.SqlShimConnectionStringBuilder. (Inherited from Devart.Data.SqlShimConnectionStringBuilder)
    Public PropertyLocalSQLEngineDetermines whether to use local SQL engine for SELECT queries, that are too complex to translate them directly to Salesforce.com or Database.com API calls or to throw an exception. (Inherited from Devart.Data.SqlShimConnectionStringBuilder)
    Public PropertyMaxPoolSizeThe maximum number of connections allowed in the pool. (Inherited from Devart.Data.SqlShimConnectionStringBuilder)
    Public PropertyMetadataCacheGets or sets the path to the metadata cache database file. If not set, the file is located in the user Application Data directory by default and is named by the Salesforce.com or Database.com account name.  
    Public PropertyMinPoolSizeThe minimum number of connections allowed in the pool. (Inherited from Devart.Data.SqlShimConnectionStringBuilder)
    Public PropertyNormalizeDbNames (Inherited from Devart.Data.SqlShimConnectionStringBuilder)
    Public PropertyOrganizationIdGets or sets a string, representing a unique identifier for the Salesforce organization to which the account you connect to belongs.  
    Public PropertyPasswordGets or sets the user's password to connect.  
    Public PropertyPersistSecurityInfoGets or sets a value indicating whether password is stored in connection string after connection is opened. (Inherited from Devart.Data.SqlShimConnectionStringBuilder)
    Public PropertyPoolingGets or sets pooling mode. (Inherited from Devart.Data.SqlShimConnectionStringBuilder)
    Public PropertyProxyHostGets or sets the host name or IP address of the proxy server to which to connect. (Inherited from Devart.Data.SqlShimConnectionStringBuilder)
    Public PropertyProxyPasswordGets or sets the password for the proxy server account. (Inherited from Devart.Data.SqlShimConnectionStringBuilder)
    Public PropertyProxyPortGets or sets the port number of the proxy server. (Inherited from Devart.Data.SqlShimConnectionStringBuilder)
    Public PropertyProxyUserGets or sets the proxy server account name. (Inherited from Devart.Data.SqlShimConnectionStringBuilder)
    Public PropertyReadonlyGets or sets a value indicating whether the connection is read-only (allows only SELECT statements). (Inherited from Devart.Data.SqlShimConnectionStringBuilder)
    Public PropertyRefreshTokenGets or sets the Salesforce OAuth 2.0 refresh token to use with RefreshToken authentication.  
    Public PropertyRunOnceCommandSpecifies a data source-specific command that should be executed immediately after first establishing the connection. Unlike InitializationCommand, this command is not executed when a connection is taken from the pool. (Inherited from Devart.Common.DbConnectionStringBuilder)
    Public PropertySecurityTokenGets or sets the automatically generated key that is used for logging in to Salesforce from an untrusted network.  
    Public PropertySessionIdGets or sets Salesforce session ID for the session ID authorization.  
    Public PropertySystemObjectsDetermines whether to provide access to Salesforce system columns such as CreationDate, IsDeleted, etc.  
    Public PropertyTokenServerGets or sets the location to store OAuth 2.0 refresh tokens between sessions. This parameter is applicable only for some of the data sources that use OAuth 2.0. It is not used in dotConnect for Salesforce. (Inherited from Devart.Data.SqlShimConnectionStringBuilder)
    Public PropertyTriggerAutoResponseEmailDetermines whether to trigger auto-response rules or not.  
    Public PropertyTriggerOtherEmailDetermines whether to trigger email outside the organization or not.  
    Public PropertyTriggerUserEmailDetermines whether to trigger email that is sent to users in the organization or not.  
    Public PropertyUpdateMruDetermines whether to update the list of most recently used items or not.  
    Public PropertyUpgradeCacheDetermines whether to upgrade the local cache database or to throw an exception in case when dotConnect for Salesforce version that uses a newer cache structure or newer version of Salesforce API discovers an old incompatible cache for the connection that is opening. Default value is true.  
    Public PropertyUseAssignmentRulesDetermines whether to use assignment rules when inserting or updating data.  
    Public PropertyUserAgent (Inherited from Devart.Data.SqlShimConnectionStringBuilder)
    Public PropertyUserIdGets or sets the name of the user to connect.  
    Public PropertyUtcDatesIndicates whether all the datetime values retrieved from Salesforce are returned as UTC values or converted to local time, and whether date values, specified on the application side (for example, in SQL statements) are considered UTC or local. (Inherited from Devart.Data.SqlShimConnectionStringBuilder)
    Public PropertyValuesCollection of values in the Devart.Data.SqlShimConnectionStringBuilder. (Inherited from Devart.Data.SqlShimConnectionStringBuilder)
    Top
    Public Methods
     NameDescription
    Public MethodAdd (Inherited from System.Data.Common.DbConnectionStringBuilder)
    Public MethodClear (Inherited from Devart.Data.SqlShimConnectionStringBuilder)
    Public MethodContainsKeyIndicates whether specified key is set in the Devart.Data.SqlShimConnectionStringBuilder object. (Inherited from Devart.Data.SqlShimConnectionStringBuilder)
    Public MethodEquivalentToOverloaded. Overridden. Returns a value indicating whether this SalesforceConnectionStringBuilder has same parameters as given DbConnectionStringBuilder.  
    Public MethodRemoveSets value of the specified key to default. (Inherited from Devart.Data.SqlShimConnectionStringBuilder)
    Public MethodShouldSerializeDetermines whether the key will be serialized if required. (Inherited from Devart.Data.SqlShimConnectionStringBuilder)
    Public MethodToString (Inherited from System.Data.Common.DbConnectionStringBuilder)
    Public MethodTryGetValueAttempts to get a key value. (Inherited from Devart.Data.SqlShimConnectionStringBuilder)
    Top
    See Also

    Reference

    SalesforceConnectionStringBuilder Class
    Devart.Data.Salesforce Namespace
    ConnectionString Property

     

     

    © 2011 - 2025 Devart. All Rights Reserved.

    Send Feedback