DeleteCommand Property (SqlDataAdapter)

In This Topic

Gets or sets a SQL Server statement to delete records from the data set.

Syntax

Visual Basic
C#

'Declaration
 
Public Shadows Property DeleteCommand As SqlCommand

public new SqlCommand DeleteCommand {get; set;}

Property Value

A SqlCommand used during an update operation to delete records in SQL Server 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 SqlCommandBuilder 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 SqlDataAdapter. 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 SqlDataAdapter.

csharp

public void UseDataAdapter(SqlConnection myConnection)
{
  SqlDataAdapter myAdapter = new SqlDataAdapter("SELECT DeptNo, DName FROM Test.Dept", myConnection);
  myAdapter.MissingSchemaAction = MissingSchemaAction.AddWithKey;
  DataSet myDataSet = new DataSet();
  myAdapter.Fill(myDataSet,"Departments");
  myDataSet.Tables["Departments"].Rows[3].Delete();
  myAdapter.DeleteCommand = new SqlCommand("DELETE FROM Test.Dept WHERE DeptNo = :DeptNo", myConnection);
  myAdapter.DeleteCommand.Parameters.Add("DeptNo", SqlType.Int, 0, "DeptNo").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(ByVal myConnection As SqlConnection)
  Dim myAdapter As SqlDataAdapter = New SqlDataAdapter("SELECT DeptNo, DName FROM Test.Dept", myConnection)
  myAdapter.MissingSchemaAction = MissingSchemaAction.AddWithKey
  Dim myDataSet As DataSet = New DataSet
  myAdapter.Fill(myDataSet, "Departments")
  myDataSet.Tables("Departments").Rows(3).Delete()
  myAdapter.DeleteCommand = New SqlCommand("DELETE FROM Test.Dept WHERE DeptNo = :DeptNo", myConnection)
  myAdapter.DeleteCommand.Parameters.Add("DeptNo", SqlType.Int, 0, "DeptNo").SourceVersion = DataRowVersion.Original
  myAdapter.Update(myDataSet, "Departments")
  Dim myTable As DataTable
  Dim myRow As DataRow
  Dim myColumn As DataColumn
  ' Get all data from all tables within the dataset
  For Each myTable In myDataSet.Tables
    For Each myRow In myTable.Rows
      For Each myColumn In myTable.Columns
        Console.Write(myRow(myColumn) & Chr(9))
      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

SqlDataAdapter Class
SqlDataAdapter Members
InsertCommand Property
SelectCommand Property
UpdateCommand Property

Send Feedback