SalesforceConnection Class

In This Topic

Syntax
Remarks
Example
Inheritance Hierarchy
Requirements
See Also

Represents an open connection to Salesforce.com or Database.com.

Syntax

Visual Basic
C#

public class SalesforceConnection : Devart.Common.DbConnectionBase, System.ComponentModel.IComponent, System.Data.IDbConnection, System.ICloneable, System.IDisposable

'Declaration
 
Public Class SalesforceConnection 
   Inherits Devart.Common.DbConnectionBase
   Implements System.ComponentModel.IComponent, System.Data.IDbConnection, System.ICloneable, System.IDisposable

Remarks

A SalesforceConnection object represents a unique connection to Salesforce.com or Database.com. Use it in conjunction with SalesforceCommand, SalesforceDataReader, SalesforceDataAdapter or other components for convenient interoperation with Salesforce.com or Database.com.

When you create an instance of SalesforceConnection, all properties are set to their initial values. For a list of these values, see ConnectionString.

If the SalesforceConnection goes out of scope, it is not closed. Therefore, you must explicitly close the connection by calling Close.

Note that SalesforceConnection instance is not guaranteed to be thread safe. You should avoid using the same SalesforceConnection in several threads at the same time. It is recommended to open a new connection per thread and to close it when the work is done. Actually, connections will not be created/disposed every time with the Pooling=true; connection string option - connections will be stored at connection pool. This boosts performance greatly.

A single SalesforceConnection can be used by many SalesforceCommand objects on the assumption that all operations will be done consecutively. In other words, you can not execute a SQL statement while an asynchronous operation is in progress.

Example

The following example creates a SalesforceCommand and a SalesforceConnection. The SalesforceConnection is opened and set as the Connection property. The example then calls ExecuteNonQuery method, and closes the connection. To accomplish this, the ExecuteNonQuery is passed a connection string and a query string that is SQL INSERT statement.

csharp

public void InsertRow(string salesforceConnectionString) 
{ 
        // If the connection string is empty, use default. 
        if(salesforceConnectionString == "") 
        { 
                salesforceConnectionString = "Server=login.salesforce.com;User Id=name@company.com;
                   Password=mypassword;Security Token=qweASDzcx1234567890rtyui;"; 
        } 
        SalesforceConnection myConn = new SalesforceConnection(salesforceConnectionString); 
        string myInsertQuery = "INSERT INTO Account(Name) Values('New account')"; 
        SalesforceCommand salesforceCommand = new SalesforceCommand(myInsertQuery); 
        salesforceCommand.Connection = myConn; 
        myConn.Open(); 
        try 
        { 
                salesforceCommand.ExecuteNonQuery(); 
        } 
        finally 
        { 
                myConn.Close(); 
        } 
}

Visual Basic

public void InsertRow(string salesforceConnectionString) 
{ 
        // If the connection string is empty, use default. 
        if(salesforceConnectionString == "") 
        { 
        salesforceConnectionString = "Server=login.salesforce.com;User Id=name@company.com;" & _
            "Password=mypassword;Security Token=qweASDzcx1234567890rtyui;"; 
        } 
SalesforceConnection myConn = new SalesforceConnection(salesforceConnectionString); 
string myInsertQuery = "INSERT INTO Account(Name) Values('New account')"; 
SalesforceCommand salesforceCommand = new SalesforceCommand(myInsertQuery); 
salesforceCommand.Connection = myConn; 
        myConn.Open(); 
        try 
        { 
                salesforceCommand.ExecuteNonQuery(); 
        } 
        finally 
        { 
                myConn.Close(); 
        } 
}

Inheritance Hierarchy

System.Object
   System.MarshalByRefObject
      System.ComponentModel.Component
         System.Data.Common.DbConnection
            Devart.Common.DbConnectionBase
               Devart.Data.Salesforce.SalesforceConnection

Requirements

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 Members
Devart.Data.Salesforce Namespace
SalesforceDataAdapter Class
SalesforceCommand Class

Send Feedback