SqlCommandBuilder.GetInsertCommand Method

public:
 Microsoft::Data::SqlClient::SqlCommand ^ GetInsertCommand();

public Microsoft.Data.SqlClient.SqlCommand GetInsertCommand ();

member this.GetInsertCommand : unit -> Microsoft.Data.SqlClient.SqlCommand

override this.GetInsertCommand : unit -> Microsoft.Data.SqlClient.SqlCommand

Public Function GetInsertCommand () As SqlCommand

Returns

The automatically generated SqlCommand object required to perform insertions.

Remarks

An application can use the GetInsertCommand method for informational or troubleshooting purposes because it returns the SqlCommand 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 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 GetInsertCommand 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 or GetInsertCommand.

For more information, see Generating Commands with CommandBuilders.

public:
 Microsoft::Data::SqlClient::SqlCommand ^ GetInsertCommand(bool useColumnsForParameterNames);

public Microsoft.Data.SqlClient.SqlCommand GetInsertCommand (bool useColumnsForParameterNames);

member this.GetInsertCommand : bool -> Microsoft.Data.SqlClient.SqlCommand

override this.GetInsertCommand : bool -> Microsoft.Data.SqlClient.SqlCommand

Public Function GetInsertCommand (useColumnsForParameterNames As Boolean) As SqlCommand

Parameters

Returns

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

Remarks

An application can use the GetInsertCommand method for informational or troubleshooting purposes because it returns the SqlCommand 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 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 GetInsertCommand 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 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 lets you force the OleDbCommandBuilder to generate parameters based on the column names instead. This succeeds only if the following conditions are met:

• The ParameterNameMaxLength returned from the GetSchema method call and found in the DataSourceInformation collection has been specified and its length is equal to or greater than the generated parameter name.

• The generated parameter name meets the criteria specified in the ParameterNamePattern returned from the GetSchema method call and found in the DataSourceInformation collection regular expression.

• A ParameterMarkerFormat returned from the GetSchema method call and found in the DataSourceInformation collection is specified.

For more information, see Generating Commands with CommandBuilders.