DB2DataAdapter.DeleteCommand Property

Syntax

[Visual Basic]
Public Property DeleteCommand As DB2Command

[C#]
public new DB2Command
 DeleteCommand {get; set;}
[C++]
public: __property DB2Command
* get_DeleteCommand();
public: __property void set_DeleteCommand(DB2Command
*);
[JScript]
public function get DeleteCommand() : DB2Command
;
public function set DeleteCommand(DB2Command
);

Property value

A DB2®Command used during an update operation to delete records in the database that correspond to deleted rows in the DataSet.

Remarks

When the DeleteCommand property is assigned to a previously created DB2Command , the DB2Command is not cloned. Instead, the DeleteCommand maintains a reference to the previously created DB2Command.

During an update operation, if DeleteCommand is not set and primary key information is present in the DataSet, you can use the DB2CommandBuilder class to automatically generate the DeleteCommand, and additional commands needed to reconcile the DataSet to the database. To do this, set the SelectCommand property of the DB2DataAdapter . The generation logic also requires key column information to be present in the DataSet. For more information see "Automatically Generated Commands" in the Microsoft(R) .NET Framework SDK documentation.

Example

[Visual Basic, C#] The following example creates a DB2DataAdapter and sets some of its properties.

[Visual Basic]
Public Sub CreateDB2DataAdapter()
     Dim mySelectText As String = _
       "SELECT * FROM STAFF ORDER BY ID"
     Dim myConnString As String = _
       "DATABASE=SAMPLE;"
     Dim myDataAdapter As New DB2DataAdapter(mySelectText, myConnString)
     Dim myDataAdapter.DeleteCommand = New DB2Command(
       "DELETE FROM STAFF WHERE JOB ='Sales' ", myConnString)
 End Sub

[C#]
public void CreateDB2DataAdapter () {
    string mySelectText = "SELECT * FROM STAFF ORDER BY ID";
    string myConnString = "DATABASE=SAMPLE;";
    DB2DataAdapter myDataAdapter = new DB2DataAdapter(mySelectText,myConnString);
    myDataAdapter.DeleteCommand = New DB2Command(
      "DELETE FROM STAFF WHERE JOB ='Sales' ", myConnString);
 }