ConnectionString Property (SalesforceConnection)

Visual Basic
C#

'Declaration
 
Public Overrides Property ConnectionString As String

public override string ConnectionString {get; set;}

Property Value

The connection string that includes the parameters needed to establish the initial connection. The default value is an empty string ("").

When ConnectionString property is assigned a value, connection closes. Many of the connection string values have corresponding properties. When the connection string is set, all of these properties are updated, except when an error is detected. In this case, none of the properties are updated. SalesforceConnection properties return only those settings contained in the ConnectionString.

Resetting the ConnectionString on a closed connection resets all connection string values (and related properties) including the password. For example, if you set a connection string that includes "User Id=test", and then reset the connection string to "Data Source=localhost", the UserId property is no longer set to test.

The connection string is parsed immediately after being set. If errors in syntax are found when parsing, a runtime exception, such as System.ArgumentException, is generated. Other errors can be found only when an attempt is made to Open the connection.

The ConnectionString is similar to an OLE DB connection string. Values may be delimited by single or double quotes, (for example, name='value' or name="value"). Either single or double quotes may be used within a connection string by using the other delimiter, for example, name="value's" or name= 'value"s', but not name= 'value's' or name= ""value"". All blank characters, except those placed within a value or within quotes, are ignored. Keyword value pairs must be separated by a semicolon (;). If a semicolon is part of a value, it also must be delimited by quotes. No escape sequences are supported. The value type is irrelevant. Names are not case sensitive. Arguments names may occur only once in the connection string.

The following table lists the valid names for values within the ConnectionString.

Name	Description
Authentication Type	Determines the authentication method to use when connecting to Salesforce.
Batch Size	The 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.
Cache All	Allows you to create cache for all the tables when connecting. Data is actually cached only when it is queried.
Client ID	The Consumer Key from the connected app definition. Used for the OAuth Refresh Token authentication.
Client Secret	The Consumer Secret from the connected app definition. Used for the OAuth Refresh Token authentication.
Connection Lifetime	When a connection is returned to the pool, its creation time is compared with the current time, and the connection is destroyed if that time span (in seconds) exceeds the value specified by Connection Lifetime. The default value is 0 (connection always returns to pool).
Connect Timeout -or- Connection Timeout	The length of time (in seconds) to wait for a connection to the server before terminating the attempt and generating an error. The default value is 15.
Data Cache	The path to the data cache database file.
Default Refresh Interval	Determines the default value of the interval in seconds between data cache refreshing. Default value is 3600 (one hour).
Deferred Login	Determines 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.
Host	The Salesforce.com or Database.com login URL.
Include Deleted	Determines whether to include the deleted records (from Salesforce recycled bin) to SELECT query results.
Initialization Command	Specifies a database-specific command that should be executed immediately after establishing the connection.
Max Pool Size	The maximum number of connections allowed in the pool. Setting the Max Pool Size value of the ConnectionString can affect performance. The default value is 100.
Metadata Cache	The path to the metadata cache database file.
Min Pool Size	The minimum number of connections allowed in the pool. The default value is 0.
Organization ID	A unique identifier for the Salesforce organization to which the account you connect to belongs.
Password	The password for the account.
Persist Security Info	Indicates if security-sensitive information, such as the password, is not returned as part of the connection if the connection is open or has ever been in an open state.
Pooling	If true, by default, the SalesforceConnection object is drawn from the appropriate pool or is created and added to the appropriate pool.
Proxy Host	The host name or IP address of proxy server.
Proxy Password	The password for the proxy server account.
Proxy Port	The port number of the proxy server. The default value is 3128.
Proxy User	The proxy server account name.
Refresh Metadata	Specifies whether to refresh Salesforce metadata each time when the connection is opened.
Refresh Token	The Salesforce OAuth 2.0 refresh token. Used for the OAuth Refresh Token authentication.
Security Token	The automatically generated key that is used for logging in to Salesforce from an untrusted network.
Session ID	Salesforce session ID for the session ID authorization.
System Objects	Specifies whether the system fields of the Salesforce objects should be accessible. Default value is false.
Trigger Auto Response Email	Specifies whether to trigger auto-response rules or not. Default value is false.
Trigger Other Email	Specifies whether to trigger email outside the organization or not. The default value is false.
Trigger User Email	Specifies whether to trigger email that is sent to users in the organization or not. The default value is false.
Update Mru	Specifies whether to update the list of most recently used items or not.
Upgrade Cache	Determines 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.
Use Assignment Rules	Determines whether to use assignment rules when inserting or updating data. The default value is false.
User ID -or- User	The Salesforce login account.
UTC Dates	Indicates 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. The default value is false.

The following example creates a SalesforceConnection and sets some of its properties in the connection string.

csharp

public void CreateSalesforceConnection()
{
  string myConnString1 = 
     "Server=login.salesforce.com;User Id= [email protected];Password=mypassword;Security Token=qweASDzcx1234567890rtyui;";
  SalesforceConnection salesforceConnection1 = new SalesforceConnection(myConnString1);
  salesforceConnection1.Open();
}

Visual Basic

Public Sub CreateSalesforceConnection()
  Dim myConnString1 As String = _
      "Server=login.salesforce.com;User Id= [email protected];Password=mypassword;Security Token=qweASDzcx1234567890rtyui;"
  Dim salesforceConnection1 As New SalesforceConnection(myConnString1)
  salesforceConnection1.Open()
End Sub

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

SalesforceConnection Class
SalesforceConnection Members
Open Method
SalesforceConnectionStringBuilder Class