SqlCommandBuilder Class

Definition

Namespace:

System.Data.SqlClient

Assembly:

System.Data.SqlClient.dll

Package:

System.Data.SqlClient v4.9.0

Source:

System.Data.SqlClient.notsupported.cs

Caution

Use the Microsoft.Data.SqlClient package instead.

Automatically generates single-table commands that are used to reconcile changes made to a DataSet with the associated SQL Server database. This class cannot be inherited.

public ref class SqlCommandBuilder sealed : System::Data::Common::DbCommandBuilder

[System.Obsolete("Use the Microsoft.Data.SqlClient package instead.")]
public sealed class SqlCommandBuilder : System.Data.Common.DbCommandBuilder

[<System.Obsolete("Use the Microsoft.Data.SqlClient package instead.")>]
type SqlCommandBuilder = class
    inherit DbCommandBuilder

Public NotInheritable Class SqlCommandBuilder
Inherits DbCommandBuilder

Inheritance

Object

MarshalByRefObject

Component

DbCommandBuilder

SqlCommandBuilder

Attributes

ObsoleteAttribute

Examples

The following example uses the SqlCommand, along SqlDataAdapter and SqlConnection, to select rows from a data source. The example is passed a connection string, a query string that is a Transact-SQL SELECT statement, and a string that is the name of the database table. The example then creates a SqlCommandBuilder.

public static DataSet SelectSqlRows(string connectionString,
    string queryString, string tableName)
{
    using (SqlConnection connection = new SqlConnection(connectionString))
    {
        SqlDataAdapter adapter = new SqlDataAdapter();
        adapter.SelectCommand = new SqlCommand(queryString, connection);
        SqlCommandBuilder builder = new SqlCommandBuilder(adapter);

        connection.Open();

        DataSet dataSet = new DataSet();
        adapter.Fill(dataSet, tableName);

        //code to modify data in DataSet here

        builder.GetUpdateCommand();

        //Without the SqlCommandBuilder this line would fail
        adapter.Update(dataSet, tableName);

        return dataSet;
    }
}

Private Function SelectSqlRows(ByVal connectionString As String, _
    ByVal queryString As String, ByVal tableName As String) As DataSet

    Using connection As New SqlConnection(connectionString)

        Dim adapter As New SqlDataAdapter()
        adapter.SelectCommand = New SqlCommand(queryString, connection)
        Dim builder As New SqlCommandBuilder(adapter)

        connection.Open()

        Dim dataSet As New DataSet()
        adapter.Fill(dataSet, tableName)

        ' Code to modify data in DataSet here 

        builder.GetUpdateCommand()

        ' Without the SqlCommandBuilder this line would fail.
        adapter.Update(dataSet, tableName)

        Return dataSet
    End Using
End Function

Remarks

The SqlDataAdapter does not automatically generate the Transact-SQL statements required to reconcile changes made to a DataSet with the associated instance of SQL Server. However, you can create a SqlCommandBuilder object to automatically generate Transact-SQL statements for single-table updates if you set the SelectCommand property of the SqlDataAdapter. Then, any additional Transact-SQL statements that you do not set are generated by the SqlCommandBuilder.

The SqlCommandBuilder registers itself as a listener for RowUpdating events whenever you set the DataAdapter property. You can only associate one SqlDataAdapter or SqlCommandBuilder object with each other at one time.

To generate INSERT, UPDATE, or DELETE statements, the SqlCommandBuilder uses the SelectCommand property to retrieve a required set of metadata automatically. If you change the SelectCommand after the metadata has been retrieved, such as after the first update, you should call the RefreshSchema method to update the metadata.

The SelectCommand must also return at least one primary key or unique column. If none are present, an InvalidOperation exception is generated, and the commands are not generated.

The SqlCommandBuilder also uses the Connection, CommandTimeout, and Transaction properties referenced by the SelectCommand. The user should call RefreshSchema if one or more of these properties are modified, or if the SelectCommand itself is replaced. Otherwise the InsertCommand, UpdateCommand, and DeleteCommand properties retain their previous values.

If you call Dispose, the SqlCommandBuilder is disassociated from the SqlDataAdapter, and the generated commands are no longer used.

Constructors

SqlCommandBuilder()	Initializes a new instance of the SqlCommandBuilder class.
SqlCommandBuilder(SqlDataAdapter)	Initializes a new instance of the SqlCommandBuilder class with the associated SqlDataAdapter object.

Properties

CanRaiseEvents	Gets a value indicating whether the component can raise an event. (Inherited from Component)
CatalogLocation	Gets or sets the CatalogLocation for an instance of the SqlCommandBuilder class.
CatalogSeparator	Gets or sets a string used as the catalog separator for an instance of the SqlCommandBuilder class.
ConflictOption	Specifies which ConflictOption is to be used by the DbCommandBuilder. (Inherited from DbCommandBuilder)
Container	Gets the IContainer that contains the Component. (Inherited from Component)
DataAdapter	Gets or sets a SqlDataAdapter object for which Transact-SQL statements are automatically generated.
DesignMode	Gets a value that indicates whether the Component is currently in design mode. (Inherited from Component)
Events	Gets the list of event handlers that are attached to this Component. (Inherited from Component)
QuotePrefix	Gets or sets the starting character or characters to use when specifying SQL Server database objects, such as tables or columns, whose names contain characters such as spaces or reserved tokens.
QuoteSuffix	Gets or sets the ending character or characters to use when specifying SQL Server database objects, such as tables or columns, whose names contain characters such as spaces or reserved tokens.
SchemaSeparator	Gets or sets the character to be used for the separator between the schema identifier and any other identifiers.
SetAllValues	Specifies whether all column values in an update statement are included or only changed ones. (Inherited from DbCommandBuilder)
Site	Gets or sets the ISite of the Component. (Inherited from Component)

Methods

ApplyParameterInfo(DbParameter, DataRow, StatementType, Boolean)	Allows the provider implementation of the DbCommandBuilder class to handle additional parameter properties. (Inherited from DbCommandBuilder)
CreateObjRef(Type)	Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject)
DeriveParameters(SqlCommand)	Retrieves parameter information from the stored procedure specified in the SqlCommand and populates the Parameters collection of the specified SqlCommand object.
Dispose()	Releases all resources used by the Component. (Inherited from Component)
Dispose(Boolean)	Releases the unmanaged resources used by the DbCommandBuilder and optionally releases the managed resources. (Inherited from DbCommandBuilder)
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetDeleteCommand()	Gets the automatically generated SqlCommand object required to perform deletions on the database.
GetDeleteCommand(Boolean)	Gets the automatically generated SqlCommand object that is required to perform deletions on the database.
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetInsertCommand()	Gets the automatically generated SqlCommand object required to perform insertions on the database.
GetInsertCommand(Boolean)	Gets the automatically generated SqlCommand object that is required to perform insertions on the database.
GetLifetimeService()	Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject)
GetParameterName(Int32)	Returns the name of the specified parameter in the format of @p#. Use when building a custom command builder. (Inherited from DbCommandBuilder)
GetParameterName(String)	Returns the full parameter name, given the partial parameter name. (Inherited from DbCommandBuilder)
GetParameterPlaceholder(Int32)	Returns the placeholder for the parameter in the associated SQL statement. (Inherited from DbCommandBuilder)
GetSchemaTable(DbCommand)	Returns the schema table for the DbCommandBuilder. (Inherited from DbCommandBuilder)
GetService(Type)	Returns an object that represents a service provided by the Component or by its Container. (Inherited from Component)
GetType()	Gets the Type of the current instance. (Inherited from Object)
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.
InitializeCommand(DbCommand)	Resets the CommandTimeout, Transaction, CommandType, and UpdateRowSource properties on the DbCommand. (Inherited from DbCommandBuilder)
InitializeLifetimeService()	Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
MemberwiseClone(Boolean)	Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject)
QuoteIdentifier(String)	Given an unquoted identifier in the correct catalog case, returns the correct quoted form of that identifier. This includes correctly escaping any embedded quotes in the identifier.
RefreshSchema()	Clears the commands associated with this DbCommandBuilder. (Inherited from DbCommandBuilder)
RowUpdatingHandler(RowUpdatingEventArgs)	Adds an event handler for the RowUpdating event. (Inherited from DbCommandBuilder)
SetRowUpdatingHandler(DbDataAdapter)	Registers the DbCommandBuilder to handle the RowUpdating event for a DbDataAdapter. (Inherited from DbCommandBuilder)
ToString()	Returns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component)
UnquoteIdentifier(String)	Given a quoted identifier, returns the correct unquoted form of that identifier. This includes correctly unescaping any embedded quotes in the identifier.

Events

Disposed

Occurs when the component is disposed by a call to the Dispose() method. (Inherited from Component)

See also

• Retrieving and Modifying Data in ADO.NET
• SQL Server and ADO.NET
• ADO.NET Overview