SqlDataAdapter.UpdateCommand Property

Gets or sets a Transact-SQL statement or stored procedure used to update records in the data source.

[Visual Basic]
Public Shadows Property UpdateCommand As SqlCommand
[C#]
public new SqlCommand UpdateCommand {get; set;}
[C++]
public: __property SqlCommand* get_UpdateCommand();
public: __property void set_UpdateCommand(SqlCommand*);
[JScript]
public hide function get UpdateCommand() : SqlCommand;
public function set UpdateCommand(SqlCommand);

Property Value

A SqlCommand used during Update to update records in the database that correspond to modified rows in the DataSet.

Remarks

During Update, if this property is not set and primary key information is present in the DataSet, the UpdateCommand can be generated automatically if you set the SelectCommand property and use the SqlCommandBuilder. Then, any additional commands that you do not set are generated by the SqlCommandBuilder. This generation logic requires key column information to be present in the DataSet. For more information see Automatically Generated Commands.

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

Note   If execution of this command returns rows, the updated rows may be merged with the DataSet depending on how you set the UpdatedRowSource property of the SqlCommand object.

Example

[Visual Basic, C#, C++] The following example creates a SqlDataAdapter and sets the SelectCommand and UpdateCommand properties. It assumes you have already created a SqlConnection object.

[Visual Basic] 
Public Shared Function CreateCustomerAdapter(conn As SqlConnection) As SqlDataAdapter 
  
  Dim da As SqlDataAdapter = New SqlDataAdapter()
  Dim cmd As SqlCommand
  Dim parm As SqlParameter

  ' Create the SelectCommand.

  cmd = New SqlCommand("SELECT * FROM Customers " & _
                       "WHERE Country = @Country AND City = @City", conn)

  cmd.Parameters.Add("@Country", SqlDbType.NVarChar, 15)
  cmd.Parameters.Add("@City", SqlDbType.NVarChar, 15)

  da.SelectCommand = cmd

  ' Create the UpdateCommand.

  cmd = New SqlCommand("UPDATE Customers SET CustomerID = @CustomerID, CompanyName = @CompanyName " & _
                       "WHERE CustomerID = @oldCustomerID", conn)

  cmd.Parameters.Add("@CustomerID", SqlDbType.NChar, 5, "CustomerID")
  cmd.Parameters.Add("@CompanyName", SqlDbType.NVarChar, 40, "CompanyName")

  parm = cmd.Parameters.Add("@oldCustomerID", SqlDbType.NChar, 5, "CustomerID")
  parm.SourceVersion = DataRowVersion.Original

  da.UpdateCommand = cmd

  Return da
End Function

[C#] 
public static SqlDataAdapter CreateCustomerAdapter(SqlConnection conn)
{
  SqlDataAdapter da = new SqlDataAdapter();
  SqlCommand cmd;
  SqlParameter parm;

  // Create the SelectCommand.

  cmd = new SqlCommand("SELECT * FROM Customers " +
                       "WHERE Country = @Country AND City = @City", conn);

  cmd.Parameters.Add("@Country", SqlDbType.NVarChar, 15);
  cmd.Parameters.Add("@City", SqlDbType.NVarChar, 15);

  da.SelectCommand = cmd;

  // Create the UpdateCommand.

  cmd = new SqlCommand("UPDATE Customers SET CustomerID = @CustomerID, CompanyName = @CompanyName " +
                       "WHERE CustomerID = @oldCustomerID", conn);

  cmd.Parameters.Add("@CustomerID", SqlDbType.NChar, 5, "CustomerID");
  cmd.Parameters.Add("@CompanyName", SqlDbType.NVarChar, 40, "CompanyName");

  parm = cmd.Parameters.Add("@oldCustomerID", SqlDbType.NChar, 5, "CustomerID");
  parm.SourceVersion = DataRowVersion.Original;

  da.UpdateCommand = cmd;

  return da;
}

[C++] 
public:
static SqlDataAdapter* CreateCustomerAdapter(SqlConnection* conn)
{
  SqlDataAdapter* da = new SqlDataAdapter();
  SqlCommand* cmd;
  SqlParameter* parm;

  // Create the SelectCommand.

  cmd = new SqlCommand(S"SELECT * FROM Customers " 
                       S"WHERE Country = @Country AND City = @City", conn);

  cmd->Parameters->Add(S"@Country", SqlDbType::NVarChar, 15);
  cmd->Parameters->Add(S"@City", SqlDbType::NVarChar, 15);

  da->SelectCommand = cmd;

  // Create the UpdateCommand.

  cmd = new SqlCommand(S"UPDATE Customers SET CustomerID = @CustomerID, CompanyName = @CompanyName " 
                       S"WHERE CustomerID = @oldCustomerID", conn);

  cmd->Parameters->Add(S"@CustomerID", SqlDbType::NChar, 5, S"CustomerID");
  cmd->Parameters->Add(S"@CompanyName", SqlDbType::NVarChar, 40, S"CompanyName");

  parm = cmd->Parameters->Add(S"@oldCustomerID", SqlDbType::NChar, 5, S"CustomerID");
  parm->SourceVersion = DataRowVersion::Original;

  da->UpdateCommand = cmd;

  return da;
}

[JScript] No example is available for JScript. To view a Visual Basic, C#, or C++ example, click the Language Filter button in the upper-left corner of the page.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, .NET Compact Framework

See Also

SqlDataAdapter Class | SqlDataAdapter Members | System.Data.SqlClient Namespace | DeleteCommand | InsertCommand | SelectCommand