DeleteCommand Property

IDbDataAdapter.DeleteCommand Property


Gets or sets an SQL statement for deleting records from the data set.

Namespace:   System.Data
Assembly:  System.Data (in System.Data.dll)

IDbCommand DeleteCommand { get; set; }

Property Value

Type: System.Data.IDbCommand

An IDbCommand used during Update to delete records in the data source for deleted rows in the data set.

During Update, if this property is not set and primary key information is present in the DataSet, the DeleteCommand can be generated automatically if you set the SelectCommand property of a .NET Framework data provider. Then, any additional commands that you do not set are generated by the CommandBuilder. This generation logic requires key column information to be present in the DataSet. For more information see Generating Commands with CommandBuilders.

When DeleteCommand is assigned to a previously created IDbCommand, the IDbCommand is not cloned. The DeleteCommand maintains a reference to the previously created IDbCommand object.

The following example creates an instance of the inherited OleDbDataAdapter class, and sets the SelectCommand and DeleteCommand properties. It assumes you have already created an OleDbConnection object.

public static OleDbDataAdapter CreateCustomerAdapter(
    OleDbConnection connection)
    OleDbDataAdapter dataAdapter = new OleDbDataAdapter();
    OleDbCommand command;
    OleDbParameter parameter;

    // Create the SelectCommand.
    command = new OleDbCommand("SELECT CustomerID FROM Customers " +
        "WHERE Country = ? AND City = ?", connection);

    command.Parameters.Add("Country", OleDbType.VarChar, 15);
    command.Parameters.Add("City", OleDbType.VarChar, 15);

    dataAdapter.SelectCommand = command;

    // Create the DeleteCommand.
    command = new OleDbCommand(
        "DELETE * FROM Customers WHERE CustomerID = ?", 

    parameter = command.Parameters.Add(
        "CustomerID", OleDbType.Char, 5, "CustomerID");
    parameter.SourceVersion = DataRowVersion.Original;

    dataAdapter.DeleteCommand = command;

    return dataAdapter;

.NET Framework
Available since 1.1
Return to top
© 2015 Microsoft