Share via

SqlCommandBuilder.GetUpdateCommand Method

  • Reference

Definition

Namespace:
Microsoft.Data.SqlClient
Assembly:
Microsoft.Data.SqlClient.dll
Package:
Microsoft.Data.SqlClient v1.0.19269.1
Package:
Microsoft.Data.SqlClient v1.1.4
Package:
Microsoft.Data.SqlClient v2.0.1
Package:
Microsoft.Data.SqlClient v2.1.4
Package:
Microsoft.Data.SqlClient v3.0.1
Package:
Microsoft.Data.SqlClient v3.1.0
Package:
Microsoft.Data.SqlClient v4.0.1
Package:
Microsoft.Data.SqlClient v4.1.0
Package:
Microsoft.Data.SqlClient v5.0.0
Package:
Microsoft.Data.SqlClient v5.1.0
Package:
Microsoft.Data.SqlClient v5.2.0
Package:
Microsoft.Data.SqlClient v6.0.2

Overloads

GetUpdateCommand()

Gets the automatically generated SqlCommand object required to perform updates on the database.
GetUpdateCommand(Boolean)

Gets the automatically generated SqlCommand object required to perform updates on the database.

GetUpdateCommand()

Source:
SqlCommandBuilder.cs
Source:
SqlCommandBuilder.cs

Gets the automatically generated SqlCommand object required to perform updates on the database.

public:
 Microsoft::Data::SqlClient::SqlCommand ^ GetUpdateCommand();
public Microsoft.Data.SqlClient.SqlCommand GetUpdateCommand();
override this.GetUpdateCommand : unit -> Microsoft.Data.SqlClient.SqlCommand
Public Function GetUpdateCommand () As SqlCommand

Returns

SqlCommand

The automatically generated SqlCommand object that is required to perform updates.

Remarks

An application can use the GetUpdateCommand() method for informational or troubleshooting purposes because it returns the SqlCommand object to be executed.

You can also use GetUpdateCommand() as the basis of a modified command. For example, you might call GetUpdateCommand() and modify the CommandTimeout value, and then explicitly set that on the SqlDataAdapter.

After the Transact-SQL statement is first generated, the application must explicitly call RefreshSchema() if it changes the statement in any way. Otherwise, the GetUpdateCommand() will still be using information from the previous statement, which might not be correct. The Transact-SQL statements are first generated when the application calls either Update(DataSet) or GetUpdateCommand().

For more information, see Generating Commands with CommandBuilders.

Applies to

GetUpdateCommand(Boolean)

Source:
SqlCommandBuilder.cs
Source:
SqlCommandBuilder.cs

Gets the automatically generated SqlCommand object required to perform updates on the database.

public:
 Microsoft::Data::SqlClient::SqlCommand ^ GetUpdateCommand(bool useColumnsForParameterNames);
public Microsoft.Data.SqlClient.SqlCommand GetUpdateCommand(bool useColumnsForParameterNames);
override this.GetUpdateCommand : bool -> Microsoft.Data.SqlClient.SqlCommand
Public Function GetUpdateCommand (useColumnsForParameterNames As Boolean) As SqlCommand

Parameters

useColumnsForParameterNames
Boolean

If true, generate parameter names matching column names if possible. If false, generate @p1, @p2, and so on.

Returns

SqlCommand

The automatically generated SqlCommand object required to perform updates.

Remarks

An application can use the GetUpdateCommand() method for informational or troubleshooting purposes because it returns the SqlCommand object to be executed.

You can also use GetUpdateCommand() as the basis of a modified command. For example, you might call GetUpdateCommand() and modify the CommandTimeout value, and then explicitly set that on the SqlDataAdapter.

After the Transact-SQL statement is first generated, the application must explicitly call RefreshSchema() if it changes the statement in any way. Otherwise, the GetUpdateCommand() will still be using information from the previous statement, which might not be correct. The Transact-SQL statements are first generated when the application calls either Update(DataSet) or GetUpdateCommand().

The default behavior, when generating parameter names, is to use @p1, @p2, and so on for the various parameters. Passing true for the useColumnsForParameterNames parameter lets you force the command builder to generate parameters based on the column names instead. This succeeds only if the following conditions are met:

For more information, see Generating Commands with CommandBuilders.

Applies to