SqlCommandBuilder SqlCommandBuilder SqlCommandBuilder SqlCommandBuilder Class

Определение

Автоматически генерирует однотабличные команды, которые позволяют согласовать изменения, вносимые в объект 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 sealed class SqlCommandBuilder : System.Data.Common.DbCommandBuilder
type SqlCommandBuilder = class
    inherit DbCommandBuilder
Public NotInheritable Class SqlCommandBuilder
Inherits DbCommandBuilder
Наследование

Примеры

В следующем примере для выбора 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

Комментарии

Не создает автоматически инструкции Transact-SQL, необходимые для согласования изменений, внесенных в объект DataSet со связанным экземпляром SQL Server. SqlDataAdapterThe 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.

Регистрируется как прослушиватель для RowUpdating DataAdapter событий при установке свойства. SqlCommandBuilderThe 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 CommandTimeoutтакже SelectCommandиспользуются свойства Connection, и Transaction , на которые ссылается.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. В противном UpdateCommandслучае свойства DeleteCommand,и сохраняют свои предыдущие значения. InsertCommandOtherwise the InsertCommand, UpdateCommand, and DeleteCommand properties retain their previous values.

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

Конструкторы

SqlCommandBuilder() SqlCommandBuilder() SqlCommandBuilder() SqlCommandBuilder()

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

SqlCommandBuilder(SqlDataAdapter) SqlCommandBuilder(SqlDataAdapter) SqlCommandBuilder(SqlDataAdapter) SqlCommandBuilder(SqlDataAdapter)

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

Свойства

CanRaiseEvents CanRaiseEvents CanRaiseEvents CanRaiseEvents

Возвращает значение, показывающее, может ли компонент вызывать событие.Gets a value indicating whether the component can raise an event.

(Inherited from Component)
CatalogLocation CatalogLocation CatalogLocation CatalogLocation

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

CatalogSeparator CatalogSeparator CatalogSeparator CatalogSeparator

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

Container Container Container Container

Возвращает контейнер IContainer, содержащий компонент Component.Gets the IContainer that contains the Component.

(Inherited from Component)
DataAdapter DataAdapter DataAdapter DataAdapter

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

DesignMode DesignMode DesignMode DesignMode

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

(Inherited from Component)
Events Events Events Events

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

(Inherited from Component)
QuotePrefix QuotePrefix QuotePrefix 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 QuoteSuffix QuoteSuffix 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 SchemaSeparator SchemaSeparator SchemaSeparator

Возвращает или задает символ, который используется в качестве разделителя между идентификатором схемы и остальными идентификаторами.Gets or sets the character to be used for the separator between the schema identifier and any other identifiers.

Site Site Site Site

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

(Inherited from Component)

Методы

CreateObjRef(Type) CreateObjRef(Type) CreateObjRef(Type) 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) DeriveParameters(SqlCommand) DeriveParameters(SqlCommand) 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() Dispose() Dispose() Dispose()

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

(Inherited from Component)
Dispose(Boolean) Dispose(Boolean) Dispose(Boolean) Dispose(Boolean)

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

(Inherited from Component)
Equals(Object) Equals(Object) Equals(Object) Equals(Object)

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

(Inherited from Object)
GetDeleteCommand() GetDeleteCommand() GetDeleteCommand() GetDeleteCommand()

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

GetDeleteCommand(Boolean) GetDeleteCommand(Boolean) GetDeleteCommand(Boolean) GetDeleteCommand(Boolean)

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

GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Служит хэш-функцией по умолчанию.Serves as the default hash function.

(Inherited from Object)
GetInsertCommand() GetInsertCommand() GetInsertCommand() GetInsertCommand()

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

GetInsertCommand(Boolean) GetInsertCommand(Boolean) GetInsertCommand(Boolean) GetInsertCommand(Boolean)

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

GetLifetimeService() GetLifetimeService() GetLifetimeService() GetLifetimeService()

Извлекает объект обслуживания во время существования, который управляет политикой времени существования данного экземпляра.Retrieves the current lifetime service object that controls the lifetime policy for this instance.

(Inherited from MarshalByRefObject)
GetService(Type) GetService(Type) GetService(Type) GetService(Type)

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

(Inherited from Component)
GetType() GetType() GetType() GetType()

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

(Inherited from Object)
GetUpdateCommand() GetUpdateCommand() GetUpdateCommand() GetUpdateCommand()

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

GetUpdateCommand(Boolean) GetUpdateCommand(Boolean) GetUpdateCommand(Boolean) GetUpdateCommand(Boolean)

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

InitializeLifetimeService() InitializeLifetimeService() InitializeLifetimeService() InitializeLifetimeService()

Получает объект службы времени существования для управления политикой времени существования для этого экземпляра.Obtains a lifetime service object to control the lifetime policy for this instance.

(Inherited from MarshalByRefObject)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

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

(Inherited from Object)
MemberwiseClone(Boolean) MemberwiseClone(Boolean) MemberwiseClone(Boolean) MemberwiseClone(Boolean)

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

(Inherited from MarshalByRefObject)
QuoteIdentifier(String) QuoteIdentifier(String) QuoteIdentifier(String) 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() RefreshSchema() RefreshSchema() RefreshSchema()

Очищает команды, связанные с данным построителем команд.Clears the commands that are associated with this command builder.

ToString() ToString() ToString() 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) UnquoteIdentifier(String) UnquoteIdentifier(String) UnquoteIdentifier(String)

При заданном идентификаторе без кавычек в каталоге, набранном в правильном регистре, возвращает заключенный в кавычки идентификатор в корректной форме.Given a quoted identifier, returns the correct unquoted form of that identifier. При этом все кавычки, внедренные в идентификатор, корректно сохраняются.This includes correctly unescaping any embedded quotes in the identifier.

События

Disposed Disposed Disposed Disposed

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

(Inherited from Component)

Применяется к

Дополнительно