Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
GetInsertCommand Method (Boolean)
Collapse the table of content
Expand the table of content

DbCommandBuilder.GetInsertCommand Method (Boolean)

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

Namespace:  System.Data.Common
Assembly:  System.Data (in System.Data.dll)

public DbCommand GetInsertCommand(
	bool useColumnsForParameterNames
)

Parameters

useColumnsForParameterNames
Type: System.Boolean

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

Return Value

Type: System.Data.Common.DbCommand
The automatically generated DbCommand object required to perform insertions.

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:

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

XNA Framework

Supported in: 3.0, 2.0, 1.0
Show:
© 2015 Microsoft