Edit

DbCommandBuilder.GetDeleteCommand Method

  • Reference

Definition

Namespace:
System.Data.Common
Assembly:
System.Data.Common.dll
Assembly:
System.Data.dll
Assembly:
netstandard.dll

Gets the automatically generated DbCommand object required to perform deletions at the data source.

Overloads

GetDeleteCommand()

Gets the automatically generated DbCommand object required to perform deletions at the data source.
GetDeleteCommand(Boolean)

Gets the automatically generated DbCommand object required to perform deletions at the data source, optionally using columns for parameter names.

Remarks

An application can use the GetDeleteCommand method for informational or troubleshooting purposes because it returns the DbCommand object to be executed.

You can also use GetDeleteCommand as the basis of a modified command. For example, you might call GetDeleteCommand and modify the associated command text, and then explicitly set that on the DbDataAdapter.

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

The default behavior, when generating parameter names, is to use @p1, @p2, and so on for the various parameters. If the overloaded version of GetDeleteCommand allows you to specify this behavior by supplying a Boolean value, you can cause the DbCommandBuilder to generate parameters based on the column names instead by passing True.

GetDeleteCommand()

Source:
DBCommandBuilder.cs
Source:
DBCommandBuilder.cs
Source:
DBCommandBuilder.cs

Gets the automatically generated DbCommand object required to perform deletions at the data source.

public:
 System::Data::Common::DbCommand ^ GetDeleteCommand();
public System.Data.Common.DbCommand GetDeleteCommand ();
member this.GetDeleteCommand : unit -> System.Data.Common.DbCommand
Public Function GetDeleteCommand () As DbCommand

Returns

DbCommand

The automatically generated DbCommand object required to perform deletions.

Remarks

An application can use the GetDeleteCommand method for informational or troubleshooting purposes because it returns the DbCommand object to be executed.

You can also use GetDeleteCommand as the basis of a modified command. For example, you might call GetDeleteCommand and modify the command text, and then explicitly set that on the DbDataAdapter.

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

See also

Applies to

GetDeleteCommand(Boolean)

Source:
DBCommandBuilder.cs
Source:
DBCommandBuilder.cs
Source:
DBCommandBuilder.cs

Gets the automatically generated DbCommand object required to perform deletions at the data source, optionally using columns for parameter names.

public:
 System::Data::Common::DbCommand ^ GetDeleteCommand(bool useColumnsForParameterNames);
public System.Data.Common.DbCommand GetDeleteCommand (bool useColumnsForParameterNames);
member this.GetDeleteCommand : bool -> System.Data.Common.DbCommand
Public Function GetDeleteCommand (useColumnsForParameterNames As Boolean) As DbCommand

Parameters

useColumnsForParameterNames
Boolean

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

Returns

DbCommand

The automatically generated DbCommand object required to perform deletions.

Remarks

An application can use the GetDeleteCommand method for informational or troubleshooting purposes because it returns the DbCommand object to be executed.

You can also use GetDeleteCommand as the basis of a modified command. For example, you might call GetDeleteCommand and modify the command text, and then explicitly set that on the DbDataAdapter.

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

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 allows you to force the DbCommandBuilder to generate parameters based on the column names instead. This succeeds only if the following conditions are met:

See also

Applies to