DbCommandBuilder.GetInsertCommand Method

Definition

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

Overloads

GetInsertCommand()

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

GetInsertCommand(Boolean)

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

Remarks

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

You can also use GetInsertCommand as the basis of a modified command. For example, you might call GetInsertCommand and modify 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 GetInsertCommand 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 GetInsertCommand.

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

GetInsertCommand()

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

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

Returns

The automatically generated DbCommand object required to perform insertions.

Remarks

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

You can also use GetInsertCommand as the basis of a modified command. For example, you might call GetInsertCommand 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 GetInsertCommand 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 GetInsertCommand.

See also

GetInsertCommand(Boolean)

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

public:
 System::Data::Common::DbCommand ^ GetInsertCommand(bool useColumnsForParameterNames);
public System.Data.Common.DbCommand GetInsertCommand (bool useColumnsForParameterNames);
member this.GetInsertCommand : bool -> System.Data.Common.DbCommand
Public Function GetInsertCommand (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

The automatically generated DbCommand object required to perform insertions.

Remarks

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

You can also use GetInsertCommand as the basis of a modified command. For example, you might call GetInsertCommand 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 GetInsertCommand 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 GetInsertCommand.

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. Generation of the parameters based on column names succeeds only if the following conditions are met:

See also

Applies to