Export (0) Print
Expand All

SqlCommandBuilder Class

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.

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

public sealed class SqlCommandBuilder : DbCommandBuilder

The SqlCommandBuilder type exposes the following members.

  NameDescription
Public methodSqlCommandBuilder()Initializes a new instance of the SqlCommandBuilder class.
Public methodSqlCommandBuilder(SqlDataAdapter)Initializes a new instance of the SqlCommandBuilder class with the associated SqlDataAdapter object.
Top

  NameDescription
Public propertyCatalogLocationSets or gets the CatalogLocation for an instance of the SqlCommandBuilder class. (Overrides DbCommandBuilder.CatalogLocation.)
Public propertyCatalogSeparatorSets or gets a string used as the catalog separator for an instance of the SqlCommandBuilder class. (Overrides DbCommandBuilder.CatalogSeparator.)
Public propertyConflictOptionSpecifies which ConflictOption is to be used by the DbCommandBuilder. (Inherited from DbCommandBuilder.)
Public propertyContainerGets the IContainer that contains the Component. (Inherited from Component.)
Public propertyDataAdapterGets or sets a SqlDataAdapter object for which Transact-SQL statements are automatically generated.
Public propertyQuotePrefixGets 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. (Overrides DbCommandBuilder.QuotePrefix.)
Public propertyQuoteSuffixGets 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. (Overrides DbCommandBuilder.QuoteSuffix.)
Public propertySchemaSeparatorGets or sets the character to be used for the separator between the schema identifier and any other identifiers. (Overrides DbCommandBuilder.SchemaSeparator.)
Public propertySetAllValuesSpecifies whether all column values in an update statement are included or only changed ones. (Inherited from DbCommandBuilder.)
Public propertySiteGets or sets the ISite of the Component. (Inherited from Component.)
Top

  NameDescription
Public methodCreateObjRefCreates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
Public methodStatic memberDeriveParametersRetrieves parameter information from the stored procedure specified in the SqlCommand and populates the Parameters collection of the specified SqlCommand object.
Public methodDispose()Releases all resources used by the Component. (Inherited from Component.)
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodGetDeleteCommand()Gets the automatically generated SqlCommand object required to perform deletions on the database.
Public methodGetDeleteCommand(Boolean)Gets the automatically generated SqlCommand object that is required to perform deletions on the database.
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetInsertCommand()Gets the automatically generated SqlCommand object required to perform insertions on the database.
Public methodGetInsertCommand(Boolean)Gets the automatically generated SqlCommand object that is required to perform insertions on the database.
Public methodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodGetUpdateCommand()Gets the automatically generated SqlCommand object required to perform updates on the database.
Public methodGetUpdateCommand(Boolean)Gets the automatically generated SqlCommand object required to perform updates on the database.
Public methodInitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Public methodQuoteIdentifierGiven 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. (Overrides DbCommandBuilder.QuoteIdentifier(String).)
Public methodRefreshSchemaClears the commands associated with this DbCommandBuilder. (Inherited from DbCommandBuilder.)
Public methodToStringReturns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component.)
Public methodUnquoteIdentifierGiven a quoted identifier, returns the correct unquoted form of that identifier. This includes correctly unescaping any embedded quotes in the identifier. (Overrides DbCommandBuilder.UnquoteIdentifier(String).)
Top

  NameDescription
Public eventDisposedOccurs when the component is disposed by a call to the Dispose method. (Inherited from Component.)
Top

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.

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;
    }
}

.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2014 Microsoft