SqlCommandBuilder 类

定义

命名空间:

System.Data.SqlClient

程序集:

System.Data.dll

自动生成用于协调通过关联的 SQL Server 数据库对 DataSet 所做更改的单表命令。 此类不能被继承。

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

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

type SqlCommandBuilder = class
    inherit DbCommandBuilder

Public NotInheritable Class SqlCommandBuilder
Inherits DbCommandBuilder

继承

Object

MarshalByRefObject

Component

DbCommandBuilder

SqlCommandBuilder

示例

以下示例使用 SqlCommand、 和 SqlDataAdapterSqlConnection从数据源中选择行。 向该示例传递连接字符串、作为 Transact-SQL SELECT 语句的查询字符串，以及作为数据库表名称的字符串。 然后，该示例创建一个 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

注解

SqlDataAdapter不会自动生成协调对 与关联的 SQL Server 实例所做的更改DataSet所需的 Transact-SQL 语句。 但是，如果设置了 SelectCommand 的 属性，则可以创建 对象SqlCommandBuilder来自动生成单表更新的 SqlDataAdapterTransact-SQL 语句。 然后，未设置的任何其他 Transact-SQL 语句都由 SqlCommandBuilder生成。

每当设置 属性时， DataAdapter 会将SqlCommandBuilder自身注册为事件的侦听器RowUpdating。 一次只能将一个 SqlDataAdapter 或 SqlCommandBuilder 对象相互关联。

若要生成 INSERT、UPDATE 或 DELETE 语句， SqlCommandBuilder 使用 SelectCommand 属性自动检索所需的元数据集。 如果在检索元数据后（例如在第一次更新之后）更改 SelectCommand ，则应调用 RefreshSchema 方法来更新元数据。

SelectCommand 还必须至少返回一个主键或唯一列。 如果不存在，则会生成 InvalidOperation 异常，并且不会生成命令。

还SqlCommandBuilder使用 Connection引用的 SelectCommand、 CommandTimeout和 Transaction 属性。 如果修改了其中一个或多个属性，或者SelectCommand替换了自身，则用户应调用 RefreshSchema 。 否则， InsertCommandUpdateCommand和 DeleteCommand 属性将保留其以前的值。

如果调用 Dispose， SqlCommandBuilder 则会取消与 SqlDataAdapter的关联，并且不再使用生成的命令。

构造函数

SqlCommandBuilder()	初始化 SqlCommandBuilder 类的新实例。
SqlCommandBuilder(SqlDataAdapter)	使用关联的 SqlCommandBuilder 对象初始化 SqlDataAdapter 类的新实例。

属性

CanRaiseEvents	获取一个指示组件是否可以引发事件的值。 (继承自 Component)
CatalogLocation	获取或设置 SqlCommandBuilder 类的实例的 CatalogLocation。
CatalogSeparator	获取或设置一个字符串，该字符串用作 SqlCommandBuilder 类的实例的目录分隔符。
ConflictOption	指定哪个 ConflictOption 将由 DbCommandBuilder 使用。 (继承自 DbCommandBuilder)
Container	获取包含 IContainer 的 Component。 (继承自 Component)
DataAdapter	获取或设置自动为其生成 Transact-SQL 语句的一个 SqlDataAdapter 对象。
DesignMode	获取一个值，用以指示 Component 当前是否处于设计模式。 (继承自 Component)
Events	获取附加到此 Component 的事件处理程序的列表。 (继承自 Component)
QuotePrefix	获取或设置在指定其名称中包含空格或保留标记等字符的 SQL Server 数据库对象（如表或列）时使用的一个或多个起始字符。
QuoteSuffix	获取或设置在指定其名称中包含空格或保留标记等字符的 SQL Server 数据库对象（如表或列）时使用的一个或多个结束字符。
SchemaSeparator	获取或设置要用作架构标识符和任何其他标识符之间的分隔符的字符。
SetAllValues	指定 update 语句中是包含所有列值还是仅包含更改的列值。 (继承自 DbCommandBuilder)
Site	获取或设置 Component 的 ISite。 (继承自 Component)

方法

ApplyParameterInfo(DbParameter, DataRow, StatementType, Boolean)	允许 DbCommandBuilder 类的提供程序实现处理附加参数属性。 (继承自 DbCommandBuilder)
CreateObjRef(Type)	创建一个对象，该对象包含生成用于与远程对象进行通信的代理所需的全部相关信息。 (继承自 MarshalByRefObject)
DeriveParameters(SqlCommand)	从在 SqlCommand 中指定的存储过程中检索参数信息并填充指定的 Parameters 对象的 SqlCommand 集合。
Dispose()	释放由 Component 使用的所有资源。 (继承自 Component)
Dispose(Boolean)	释放由 DbCommandBuilder 占用的非托管资源，还可以另外再释放托管资源。 (继承自 DbCommandBuilder)
Equals(Object)	确定指定对象是否等于当前对象。 (继承自 Object)
GetDeleteCommand()	获取自动生成的、对数据库执行删除操作所需的 SqlCommand 对象。
GetDeleteCommand(Boolean)	获取自动生成的、对数据库执行删除操作所需的 SqlCommand 对象。
GetHashCode()	作为默认哈希函数。 (继承自 Object)
GetInsertCommand()	获取自动生成的、对数据库执行插入操作所需的 SqlCommand 对象。
GetInsertCommand(Boolean)	获取自动生成的、对数据库执行插入操作所需的 SqlCommand 对象。
GetLifetimeService()	检索控制此实例的生存期策略的当前生存期服务对象。 (继承自 MarshalByRefObject)
GetParameterName(Int32)	以 格式 @p#返回指定参数的名称。 在生成自定义命令生成器时使用。 (继承自 DbCommandBuilder)
GetParameterName(String)	给定部分参数名，返回完整参数名。 (继承自 DbCommandBuilder)
GetParameterPlaceholder(Int32)	返回该参数在关联的 SQL 语句中的占位符。 (继承自 DbCommandBuilder)
GetSchemaTable(DbCommand)	返回 DbCommandBuilder 的架构表。 (继承自 DbCommandBuilder)
GetService(Type)	返回一个对象，该对象表示由 Component 或它的 Container 提供的服务。 (继承自 Component)
GetType()	获取当前实例的 Type。 (继承自 Object)
GetUpdateCommand()	获取自动生成的、对数据库执行更新操作所需的 SqlCommand 对象。
GetUpdateCommand(Boolean)	获取自动生成的、对数据库执行更新操作所需的 SqlCommand 对象。
InitializeCommand(DbCommand)	重置 CommandTimeout 上的 Transaction、CommandType、UpdateRowSource 和 DbCommand 属性。 (继承自 DbCommandBuilder)
InitializeLifetimeService()	获取生存期服务对象来控制此实例的生存期策略。 (继承自 MarshalByRefObject)
MemberwiseClone()	创建当前 Object 的浅表副本。 (继承自 Object)
MemberwiseClone(Boolean)	创建当前 MarshalByRefObject 对象的浅表副本。 (继承自 MarshalByRefObject)
QuoteIdentifier(String)	给定了具有正确的目录大小写设置且不带引号的标识符时，返回该标识符的正确的带引号形式。 这包括正确地转义该标识符中的任何嵌入引号。
RefreshSchema()	清除与此 DbCommandBuilder 关联的命令。 (继承自 DbCommandBuilder)
RowUpdatingHandler(RowUpdatingEventArgs)	添加 RowUpdating 事件的事件处理程序。 (继承自 DbCommandBuilder)
SetRowUpdatingHandler(DbDataAdapter)	注册 DbCommandBuilder 以处理 RowUpdating 的 DbDataAdapter 事件。 (继承自 DbCommandBuilder)
ToString()	返回包含 Component 的名称的 String（如果有）。 不应重写此方法。 (继承自 Component)
UnquoteIdentifier(String)	给定了带引号的标识符时，返回该标识符的正确的不带引号的形式。 这包括正确地非转义该标识符的所有嵌入的引号。

事件

Disposed

在通过调用 Dispose() 方法释放组件时发生。 (继承自 Component)

另请参阅

• 在 ADO.NET 中检索和修改数据
• SQL Server 和 ADO.NET
• ADO.NET 概述