DeleteCommand Property

In This Topic

Gets or sets Salesforce.com or Database.com statement to delete records from the data set.

Syntax

Visual Basic
C#

'Declaration
 
Public Shadows Property DeleteCommand As SalesforceCommand

public new SalesforceCommand DeleteCommand {get; set;}

Property Value

A SalesforceCommand used during an update operation to delete records in Salesforce.com or Database.com that correspond to deleted rows in the System.Data.DataSet.

Remarks

During an update operation, if DeleteCommand is not set and primary key information is present in the System.Data.DataSet, you can use the SalesforceCommandBuilder class to automatically generate the DeleteCommand, and additional commands needed to reconcile the System.Data.DataSet to the data source. To do this, set the SelectCommand property of the SalesforceDataAdapter. For more information see "Automatically Generated Commands" in the Microsoft .NET Framework SDK documentation.

Example

The following example demonstrates how to retrieve and manipulate data using SalesforceDataAdapter.

csharp

public void UseDataAdapter(SalesforceConnection salesforceConnection) 
{ 
        SalesforceDataAdapter myAdapter = new SalesforceDataAdapter("SELECT ID, Name FROM Account", salesforceConnection); 
        myAdapter.MissingSchemaAction = MissingSchemaAction.AddWithKey; 
        DataSet myDataSet = new DataSet(); 
        myAdapter.Fill(myDataSet,"Accounts"); 
        myDataSet.Tables["Accounts"].Rows[3].Delete(); 
        myAdapter.DeleteCommand = new SalesforceCommand("DELETE FROM Account WHERE ID = :ID", salesforceConnection); 
        myAdapter.DeleteCommand.Parameters.Add("ID", SalesforceType.String, 18, "ID").SourceVersion = DataRowVersion.Original; 
        myAdapter.Update(myDataSet,"Departments");  
   
        //Get all data from all tables within the dataset 
        foreach(DataTable myTable in myDataSet.Tables) 
        { 
                foreach(DataRow myRow in myTable.Rows) 
                { 
                        foreach (DataColumn myColumn in myTable.Columns) 
                        { 
                                Console.Write(myRow[myColumn]+"\t"); 
                        } 
                        Console.WriteLine(); 
                } 
                Console.WriteLine(); 
        } 
}

Visual Basic

Public Sub UseDataAdapter(salesforceConnection As SalesforceConnection)
        Dim myAdapter As New SalesforceDataAdapter("SELECT ID, Name FROM Account", salesforceConnection)
        myAdapter.MissingSchemaAction = MissingSchemaAction.AddWithKey
        Dim myDataSet As New DataSet()
        myAdapter.Fill(myDataSet, "Accounts")
        myDataSet.Tables("Accounts").Rows(3).Delete()
        myAdapter.DeleteCommand = New SalesforceCommand("DELETE FROM Account WHERE ID = :ID", salesforceConnection)
        myAdapter.DeleteCommand.Parameters.Add("ID", SalesforceType.String, 18, "ID").SourceVersion = DataRowVersion.Original
        myAdapter.Update(myDataSet, "Departments")

        'Get all data from all tables within the dataset 
        For Each myTable As DataTable In myDataSet.Tables
                For Each myRow As DataRow In myTable.Rows
                        For Each myColumn As DataColumn In myTable.Columns
                                Console.Write(myRow(myColumn) + vbTab)
                        Next myColumn
                        Console.WriteLine()
                Next myRow
                Console.WriteLine()
        Next myTable
End Sub

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

SalesforceDataAdapter Class
SalesforceDataAdapter Members
InsertCommand Property
SelectCommand Property
UpdateCommand Property

Send Feedback