SqlCommandBuilder Class

Definition

Автоматически создает однотабличные команды, используемые для выверки изменений, внесенных в DataSet, со связанной базой данных SQL Server.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
public ref class SqlCommandBuilder sealed : System::ComponentModel::Component
public sealed class SqlCommandBuilder : System.Data.Common.DbCommandBuilder
public sealed class SqlCommandBuilder : System.ComponentModel.Component
type SqlCommandBuilder = class
    inherit DbCommandBuilder
type SqlCommandBuilder = class
    inherit Component
Public NotInheritable Class SqlCommandBuilder
Inherits DbCommandBuilder
Public NotInheritable Class SqlCommandBuilder
Inherits Component
Inheritance
Inheritance
SqlCommandBuilder

Examples

В следующем примере используется SqlCommand, а также SqlDataAdapter и SqlConnectionдля выбора строк из источника данных.The following example uses the SqlCommand, along SqlDataAdapter and SqlConnection, to select rows from a data source. В примере передается строка подключения, строка запроса, которая является инструкцией Transact-SQL SELECT, и строка, которая является именем таблицы базы данных.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. Затем в примере создается SqlCommandBuilder.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

SqlDataAdapter не создает автоматически инструкции Transact-SQL, необходимые для согласования изменений, внесенных в DataSet со связанным экземпляром SQL Server.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. Однако можно создать SqlCommandBuilder объект для автоматического создания инструкций Transact-SQL для однотабличных обновлений, если задать свойство SelectCommand SqlDataAdapter.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. Затем все дополнительные инструкции Transact-SQL, которые не заданы, создаются SqlCommandBuilder.Then, any additional Transact-SQL statements that you do not set are generated by the SqlCommandBuilder.

SqlCommandBuilder регистрирует себя в качестве прослушивателя для событий RowUpdating каждый раз, когда задано свойство DataAdapter.The SqlCommandBuilder registers itself as a listener for RowUpdating events whenever you set the DataAdapter property. Одновременно можно связать только один SqlDataAdapter или SqlCommandBuilder объект.You can only associate one SqlDataAdapter or SqlCommandBuilder object with each other at one time.

Чтобы создать инструкции INSERT, UPDATE или DELETE, SqlCommandBuilder использует свойство SelectCommand для автоматического получения требуемого набора метаданных.To generate INSERT, UPDATE, or DELETE statements, the SqlCommandBuilder uses the SelectCommand property to retrieve a required set of metadata automatically. При изменении SelectCommand после получения метаданных, например после первого обновления, следует вызвать метод RefreshSchema для обновления метаданных.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.

Свойство SelectCommand должно также возвратить по крайней мере один столбец первичного ключа или столбец с атрибутом UNIQUE.The SelectCommand must also return at least one primary key or unique column. Если они отсутствуют, создается исключение InvalidOperation , и команды не создаются.If none are present, an InvalidOperation exception is generated, and the commands are not generated.

SqlCommandBuilder также использует свойства Connection, CommandTimeoutи Transaction, на которые ссылается SelectCommand.The SqlCommandBuilder also uses the Connection, CommandTimeout, and Transaction properties referenced by the SelectCommand. Пользователь должен вызвать RefreshSchema, если одно или несколько из этих свойств изменяются или заменяются самим SelectCommand.The user should call RefreshSchema if one or more of these properties are modified, or if the SelectCommand itself is replaced. В противном случае свойства InsertCommand, UpdateCommandи DeleteCommand сохраняют свои предыдущие значения.Otherwise the InsertCommand, UpdateCommand, and DeleteCommand properties retain their previous values.

При вызове DisposeSqlCommandBuilder не связывается с SqlDataAdapter, а созданные команды больше не используются.If you call Dispose, the SqlCommandBuilder is disassociated from the SqlDataAdapter, and the generated commands are no longer used.

Constructors

SqlCommandBuilder()

Инициализирует новый экземпляр класса SqlCommandBuilder.Initializes a new instance of the SqlCommandBuilder class.

SqlCommandBuilder(SqlDataAdapter)

Инициализирует новый экземпляр класса 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

Возвращает или задает CatalogLocation для экземпляра класса SqlCommandBuilder.Gets or sets the CatalogLocation for an instance of the SqlCommandBuilder class.

CatalogSeparator

Возвращает или задает строку, которую можно использовать в качестве разделителя каталогов для экземпляра класса SqlCommandBuilder.Gets or sets a string used as the catalog separator for an instance of the SqlCommandBuilder class.

ConflictOption

Указывает, какое значение типа ConflictOption должно использоваться объектом DbCommandBuilder.Specifies which ConflictOption is to be used by the DbCommandBuilder.

(Inherited from DbCommandBuilder)
Container

Возвращает объект IContainer, который содержит коллекцию Component.Gets the IContainer that contains the Component.

(Inherited from Component)
DataAdapter

Возвращает или задает объект SqlDataAdapter, для которого автоматически создаются инструкции Transact-SQL.Gets or sets a SqlDataAdapter object for which Transact-SQL statements are automatically generated.

DesignMode

Возвращает значение, указывающее, находится ли данный компонент Component в режиме конструктора в настоящее время.Gets a value that indicates whether the Component is currently in design mode.

(Inherited from Component)
Events

Возвращает список обработчиков событий, которые прикреплены к этому объекту Component.Gets the list of event handlers that are attached to this Component.

(Inherited from Component)
QuotePrefix

Получает или задает начальный символ или символы, используемые для указания объектов базы данных SQL Server (например, таблиц или столбцов), имена которых содержат такие символы, как пробелы или зарезервированные токены.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

Получает или задает конечный символ или символы, используемые для указания объектов базы данных SQL Server (например, таблиц или столбцов), имена которых содержат такие символы, как пробелы или зарезервированные токены.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

Указывает, включены все значения столбца в инструкции UPDATE или только измененные значения.Specifies whether all column values in an update statement are included or only changed ones.

(Inherited from DbCommandBuilder)
Site

Возвращает или задает ISite объекта Component.Gets or sets the ISite of the Component.

(Inherited from Component)

Methods

ApplyParameterInfo(DbParameter, DataRow, StatementType, Boolean)

Разрешает реализации поставщика класса DbCommandBuilder обрабатывать дополнительные свойства параметров.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)

Извлекает сведения о параметрах из хранимой процедуры, указанной в объекте SqlCommand, и включает их в коллекцию параметров Parameters указанного объекта SqlCommand.Retrieves parameter information from the stored procedure specified in the SqlCommand and populates the Parameters collection of the specified SqlCommand object.

Dispose()

Освобождает все ресурсы, используемые Component.Releases all resources used by the Component.

(Inherited from Component)
Dispose(Boolean)

Освобождает неуправляемые ресурсы, используемые DbCommandBuilder, и дополнительно освобождает управляемые ресурсы.Releases the unmanaged resources used by the DbCommandBuilder and optionally releases the managed resources.

(Inherited from DbCommandBuilder)
Dispose(Boolean)

Освобождает неуправляемые ресурсы, используемые Component, и дополнительно освобождает управляемые ресурсы.Releases the unmanaged resources used by the Component and optionally releases the managed resources.

(Inherited from Component)
Equals(Object)

Определяет, равен ли заданный объект текущему объекту.Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetDeleteCommand()

Получает автоматически созданный объект SqlCommand, который требуется для выполнения операций удаления в базе данных.Gets the automatically generated SqlCommand object required to perform deletions on the database.

GetDeleteCommand(Boolean)

Получает автоматически созданный объект SqlCommand, который требуется для выполнения операций удаления в базе данных.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()

Получает автоматически созданный объект SqlCommand, который требуется для выполнения операций вставки в базу данных.Gets the automatically generated SqlCommand object required to perform insertions on the database.

GetInsertCommand(Boolean)

Получает автоматически созданный объект SqlCommand, который требуется для выполнения операций вставки в базе данных.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)

Возвращает имя указанного параметра в формате @p#.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)

Возвращает местозаполнитель для параметра в связанной инструкции SQL.Returns the placeholder for the parameter in the associated SQL statement.

(Inherited from DbCommandBuilder)
GetSchemaTable(DbCommand)

Возвращает таблицу схемы для объекта DbCommandBuilder.Returns the schema table for the DbCommandBuilder.

(Inherited from DbCommandBuilder)
GetService(Type)

Возвращает объект, представляющий службу, предоставляемую классом Component или классом Container.Returns an object that represents a service provided by the Component or by its Container.

(Inherited from Component)
GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Inherited from Object)
GetUpdateCommand()

Получает автоматически созданный объект SqlCommand, который требуется для выполнения обновлений базы данных.Gets the automatically generated SqlCommand object required to perform updates on the database.

GetUpdateCommand(Boolean)

Получает автоматически созданный объект SqlCommand, который требуется для выполнения обновлений базы данных.Gets the automatically generated SqlCommand object required to perform updates on the database.

InitializeCommand(DbCommand)

Сбрасывает свойства CommandTimeout, Transaction, CommandType и UpdateRowSource в объекте 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()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Inherited from Object)
MemberwiseClone(Boolean)

Создает неполную копию текущего объекта MarshalByRefObject.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 that are associated with this command builder.

RefreshSchema()

Очищает команды, связанные с этим объектом DbCommandBuilder.Clears the commands associated with this DbCommandBuilder.

(Inherited from DbCommandBuilder)
RowUpdatingHandler(RowUpdatingEventArgs)

Добавляет обработчик событий для события RowUpdating.Adds an event handler for the RowUpdating event.

(Inherited from DbCommandBuilder)
SetRowUpdatingHandler(DbDataAdapter)

Регистрирует объект DbCommandBuilder, чтобы обработать событие RowUpdating для объекта DbDataAdapter.Registers the DbCommandBuilder to handle the RowUpdating event for a DbDataAdapter.

(Inherited from DbCommandBuilder)
ToString()

Возвращает объект String, содержащий имя Component, если оно есть.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

Возникает при удалении компонента путем вызова метода Dispose().Occurs when the component is disposed by a call to the Dispose() method.

(Inherited from Component)

Applies to

See also