SqlCommandBuilder Klasse

Definition

Generiert automatisch Befehle für einzelne Tabellen, durch die an einem DataSetvorgenommene Änderungen mit der zugeordneten SQL Server-Datenbank abgeglichen werden.Automatically generates single-table commands that are used to reconcile changes made to a DataSet with the associated SQL Server database. Diese Klasse kann nicht vererbt werden.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
Vererbung
Vererbung
SqlCommandBuilder

Beispiele

Im folgenden Beispiel wird der SqlCommandzusammen mit SqlDataAdapter und SqlConnectionverwendet, um Zeilen aus einer Datenquelle auszuwählen.The following example uses the SqlCommand, along SqlDataAdapter and SqlConnection, to select rows from a data source. Dem Beispiel wird eine Verbindungs Zeichenfolge, eine Abfrage Zeichenfolge, die eine SELECT-Anweisung von Transact-SQL ist, und eine Zeichenfolge, die den Namen der Datenbanktabelle ist,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. Im Beispiel wird dann ein SqlCommandBuildererstellt.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

Hinweise

Der SqlDataAdapter generiert nicht automatisch die Transact-SQL-Anweisungen, die erforderlich sind, um Änderungen, die an einem DataSet vorgenommen wurden, mit der zugeordneten Instanz von SQL Server abzustimmen.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. Sie können jedoch ein SqlCommandBuilder Objekt erstellen, um automatisch Transact-SQL-Anweisungen für Aktualisierungen in einer Tabelle zu generieren, wenn Sie die SelectCommand-Eigenschaft der SqlDataAdapterfestlegen.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. Anschließend werden alle weiteren Transact-SQL-Anweisungen, die Sie nicht festlegen, vom SqlCommandBuildergeneriert.Then, any additional Transact-SQL statements that you do not set are generated by the SqlCommandBuilder.

Der SqlCommandBuilder sich selbst als Listener für RowUpdating Ereignisse registriert, wenn Sie die DataAdapter-Eigenschaft festlegen.The SqlCommandBuilder registers itself as a listener for RowUpdating events whenever you set the DataAdapter property. Sie können jeweils nur eine SqlDataAdapter oder ein SqlCommandBuilder Objekt zuordnen.You can only associate one SqlDataAdapter or SqlCommandBuilder object with each other at one time.

Zum Generieren von INSERT-, Update-oder DELETE-Anweisungen verwendet der SqlCommandBuilder die SelectCommand-Eigenschaft, um einen erforderlichen Satz von Metadaten automatisch abzurufen.To generate INSERT, UPDATE, or DELETE statements, the SqlCommandBuilder uses the SelectCommand property to retrieve a required set of metadata automatically. Wenn Sie die SelectCommand nach dem Abrufen der Metadaten ändern (z. b. nach dem ersten Update), sollten Sie die RefreshSchema-Methode zum Aktualisieren der Metadaten abrufen.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.

Der SelectCommand muss außerdem mindestens einen Primärschlüssel oder eine eindeutige Spalte zurückgeben.The SelectCommand must also return at least one primary key or unique column. Wenn keines vorhanden ist, wird eine InvalidOperation -Ausnahme generiert, und die Befehle werden nicht generiert.If none are present, an InvalidOperation exception is generated, and the commands are not generated.

Der SqlCommandBuilder verwendet auch die Eigenschaften Connection, CommandTimeoutund Transaction, auf die der SelectCommandverweist.The SqlCommandBuilder also uses the Connection, CommandTimeout, and Transaction properties referenced by the SelectCommand. Der Benutzer sollte RefreshSchema anrufen, wenn eine oder mehrere dieser Eigenschaften geändert werden, oder wenn der SelectCommand selbst ersetzt wird.The user should call RefreshSchema if one or more of these properties are modified, or if the SelectCommand itself is replaced. Andernfalls behalten die Eigenschaften InsertCommand, UpdateCommandund DeleteCommand Ihre vorherigen Werte bei.Otherwise the InsertCommand, UpdateCommand, and DeleteCommand properties retain their previous values.

Wenn Sie Disposeaufzurufen, wird die SqlCommandBuilder der SqlDataAdaptergetrennt, und die generierten Befehle werden nicht mehr verwendet.If you call Dispose, the SqlCommandBuilder is disassociated from the SqlDataAdapter, and the generated commands are no longer used.

Konstruktoren

SqlCommandBuilder()

Initialisiert eine neue Instanz der SqlCommandBuilder-Klasse.Initializes a new instance of the SqlCommandBuilder class.

SqlCommandBuilder(SqlDataAdapter)

Initialisiert eine neue Instanz der SqlCommandBuilder-Klasse mit dem zugeordneten SqlDataAdapter-Objekt.Initializes a new instance of the SqlCommandBuilder class with the associated SqlDataAdapter object.

Eigenschaften

CanRaiseEvents

Ruft einen Wert ab, der angibt, ob die Komponente ein Ereignis auslösen kann.Gets a value indicating whether the component can raise an event.

(Geerbt von Component)
CatalogLocation

Ruft die CatalogLocation für eine Instanz der SqlCommandBuilder-Klasse ab oder legt sie fest.Gets or sets the CatalogLocation for an instance of the SqlCommandBuilder class.

CatalogSeparator

Ruft eine Zeichenfolge als Katalogtrennzeichen für eine Instanz der SqlCommandBuilder-Klasse ab oder legt sie fest.Gets or sets a string used as the catalog separator for an instance of the SqlCommandBuilder class.

ConflictOption

Gibt an, welche ConflictOption vom DbCommandBuilder verwendet werden muss.Specifies which ConflictOption is to be used by the DbCommandBuilder.

(Geerbt von DbCommandBuilder)
Container

Ruft die IContainer ab, die in der Component enthalten ist.Gets the IContainer that contains the Component.

(Geerbt von Component)
DataAdapter

Ruft ein SqlDataAdapter-Objekt ab, für das automatisch Transact-SQL-Anweisungen generiert werden, oder legt dieses fest.Gets or sets a SqlDataAdapter object for which Transact-SQL statements are automatically generated.

DesignMode

Ruft einen Wert ab, der angibt, ob sich Component gegenwärtig im Entwurfsmodus befindet.Gets a value that indicates whether the Component is currently in design mode.

(Geerbt von Component)
Events

Ruft die Liste der Ereignishandler ab, die dieser Component angefügt sind.Gets the list of event handlers that are attached to this Component.

(Geerbt von Component)
QuotePrefix

Ruft das oder die Anfangszeichen ab, die beim Angeben von SQL Server-Datenbankobjekten (z. B. Tabellen oder Spalten) verwendet werden sollen, deren Namen Leerzeichen oder reservierte Token enthalten, oder legt diese fest.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

Ruft das oder die Endzeichen ab, die beim Angeben von SQL Server-Datenbankobjekten (z. B. Tabellen oder Spalten) verwendet werden sollen, deren Namen Leerzeichen oder reservierte Token enthalten, oder legt diese fest.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

Ruft das als Trennzeichen zwischen dem Schemabezeichner und anderen Bezeichnern zu verwendende Zeichen ab oder legt dieses fest.Gets or sets the character to be used for the separator between the schema identifier and any other identifiers.

SetAllValues

Gibt an, ob alle Spaltenwerte oder nur die geänderten in einer Aktualisierungsanweisung eingeschlossen sind.Specifies whether all column values in an update statement are included or only changed ones.

(Geerbt von DbCommandBuilder)
Site

Ruft den ISite von Component ab oder legt ihn fest.Gets or sets the ISite of the Component.

(Geerbt von Component)

Methoden

ApplyParameterInfo(DbParameter, DataRow, StatementType, Boolean)

Ermöglicht es der Anbieterimplementierung der DbCommandBuilder-Klasse, zusätzliche Parametereigenschaften zu behandeln.Allows the provider implementation of the DbCommandBuilder class to handle additional parameter properties.

(Geerbt von DbCommandBuilder)
CreateObjRef(Type)

Erstellt ein Objekt mit allen relevanten Informationen, die zum Generieren eines Proxys für die Kommunikation mit einem Remoteobjekt erforderlich sind.Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.

(Geerbt von MarshalByRefObject)
DeriveParameters(SqlCommand)

Ruft Parameterinformationen aus der im SqlCommand angegebenen gespeicherten Prozedur ab und füllt die Parameters-Auflistung des angegebenen SqlCommand-Objekts auf.Retrieves parameter information from the stored procedure specified in the SqlCommand and populates the Parameters collection of the specified SqlCommand object.

Dispose()

Gibt alle von Component verwendeten Ressourcen frei.Releases all resources used by the Component.

(Geerbt von Component)
Dispose(Boolean)

Gibt die von DbCommandBuilder verwendeten nicht verwalteten Ressourcen und optional die verwalteten Ressourcen frei.Releases the unmanaged resources used by the DbCommandBuilder and optionally releases the managed resources.

(Geerbt von DbCommandBuilder)
Dispose(Boolean)

Gibt die von Component verwendeten nicht verwalteten Ressourcen und optional die verwalteten Ressourcen frei.Releases the unmanaged resources used by the Component and optionally releases the managed resources.

(Geerbt von Component)
Equals(Object)

Bestimmt, ob das angegebene Objekt gleich dem aktuellen Objekt ist.Determines whether the specified object is equal to the current object.

(Geerbt von Object)
GetDeleteCommand()

Ruft das automatisch generierte SqlCommand-Objekt ab, das für die Ausführung von Löschvorgängen in der Datenbank erforderlich ist.Gets the automatically generated SqlCommand object required to perform deletions on the database.

GetDeleteCommand(Boolean)

Ruft das automatisch generierte SqlCommand-Objekt ab, das für die Ausführung von Löschvorgängen in der Datenbank erforderlich ist.Gets the automatically generated SqlCommand object that is required to perform deletions on the database.

GetHashCode()

Dient als die Standard-HashfunktionServes as the default hash function.

(Geerbt von Object)
GetInsertCommand()

Ruft das automatisch generierte SqlCommand-Objekt ab, das für das Ausführen von Einfügevorgängen in der Datenbank erforderlich ist.Gets the automatically generated SqlCommand object required to perform insertions on the database.

GetInsertCommand(Boolean)

Ruft das automatisch generierte SqlCommand-Objekt ab, das für das Ausführen von Einfügevorgängen in der Datenbank erforderlich ist.Gets the automatically generated SqlCommand object that is required to perform insertions on the database.

GetLifetimeService()

Ruft das aktuelle Lebensdauerdienstobjekt ab, das die Lebensdauerrichtlinien für diese Instanz steuert.Retrieves the current lifetime service object that controls the lifetime policy for this instance.

(Geerbt von MarshalByRefObject)
GetParameterName(Int32)

Gibt den Namen des angegebenen Parameters im Format @p# zurück.Returns the name of the specified parameter in the format of @p#. Verwenden Sie diesen zum Erstellen eines benutzerdefinierten Befehls-Generators.Use when building a custom command builder.

(Geerbt von DbCommandBuilder)
GetParameterName(String)

Gibt den vollständigen Parameternamen zurück, wenn der partielle Parameternamen angegeben ist.Returns the full parameter name, given the partial parameter name.

(Geerbt von DbCommandBuilder)
GetParameterPlaceholder(Int32)

Gibt den Platzhalter für den Parameter in der zugeordneten SQL-Anweisung zurück.Returns the placeholder for the parameter in the associated SQL statement.

(Geerbt von DbCommandBuilder)
GetSchemaTable(DbCommand)

Gibt die Schematabelle für den DbCommandBuilder zurück.Returns the schema table for the DbCommandBuilder.

(Geerbt von DbCommandBuilder)
GetService(Type)

Gibt ein Objekt zurück, das einen von der Component oder von deren Container bereitgestellten Dienst darstellt.Returns an object that represents a service provided by the Component or by its Container.

(Geerbt von Component)
GetType()

Ruft den Type der aktuellen Instanz ab.Gets the Type of the current instance.

(Geerbt von Object)
GetUpdateCommand()

Ruft das automatisch generierte SqlCommand-Objekt ab, das für das Ausführen von Aktualisierungen in der Datenbank erforderlich ist.Gets the automatically generated SqlCommand object required to perform updates on the database.

GetUpdateCommand(Boolean)

Ruft das automatisch generierte SqlCommand-Objekt ab, das für das Ausführen von Aktualisierungen in der Datenbank erforderlich ist.Gets the automatically generated SqlCommand object required to perform updates on the database.

InitializeCommand(DbCommand)

Legt die Eigenschaften CommandTimeout, Transaction, CommandType und UpdateRowSource für DbCommand erneut fest.Resets the CommandTimeout, Transaction, CommandType, and UpdateRowSource properties on the DbCommand.

(Geerbt von DbCommandBuilder)
InitializeLifetimeService()

Ruft ein Lebensdauerdienstobjekt zur Steuerung der Lebensdauerrichtlinie für diese Instanz ab.Obtains a lifetime service object to control the lifetime policy for this instance.

(Geerbt von MarshalByRefObject)
MemberwiseClone()

Erstellt eine flache Kopie des aktuellen Object.Creates a shallow copy of the current Object.

(Geerbt von Object)
MemberwiseClone(Boolean)

Erstellt eine flache Kopie des aktuellen MarshalByRefObject-Objekts.Creates a shallow copy of the current MarshalByRefObject object.

(Geerbt von MarshalByRefObject)
QuoteIdentifier(String)

Bei einem Bezeichner ohne Anführungszeichen in der richtigen Katalogschreibweise wird die korrekte Form des jeweiligen Bezeichners mit Anführungszeichen zurückgegeben.Given an unquoted identifier in the correct catalog case, returns the correct quoted form of that identifier. Dies schließt ein, dass eingebettete Anführungszeichen im Bezeichner ordnungsgemäß mit Escapezeichen versehen werden.This includes correctly escaping any embedded quotes in the identifier.

RefreshSchema()

Löscht die Befehle, die diesem Befehlsgenerator zugeordnet sind.Clears the commands that are associated with this command builder.

RefreshSchema()

Löscht die diesem DbCommandBuilder zugeordneten Befehle.Clears the commands associated with this DbCommandBuilder.

(Geerbt von DbCommandBuilder)
RowUpdatingHandler(RowUpdatingEventArgs)

Fügt einen Ereignishandler für das RowUpdating-Ereignis hinzu.Adds an event handler for the RowUpdating event.

(Geerbt von DbCommandBuilder)
SetRowUpdatingHandler(DbDataAdapter)

Registriert den DbCommandBuilder zum Behandeln des RowUpdating-Ereignisses für einen DbDataAdapter.Registers the DbCommandBuilder to handle the RowUpdating event for a DbDataAdapter.

(Geerbt von DbCommandBuilder)
ToString()

Gibt einen String zurück, der den Namen der Component enthält (sofern vorhanden).Returns a String containing the name of the Component, if any. Diese Methode darf nicht überschrieben werden.This method should not be overridden.

(Geerbt von Component)
UnquoteIdentifier(String)

Bei einem Bezeichner mit Anführungszeichen wird die korrekte Form dieses Bezeichners ohne Anführungszeichen zurückgegeben.Given a quoted identifier, returns the correct unquoted form of that identifier. Dies schließt ein, dass eingebettete Anführungszeichen im Bezeichner ordnungsgemäß ohne Escapezeichen verwendet werden.This includes correctly unescaping any embedded quotes in the identifier.

Ereignisse

Disposed

Tritt auf, wenn die Komponente von einem Aufruf der Dispose()-Methode verworfen wird.Occurs when the component is disposed by a call to the Dispose() method.

(Geerbt von Component)

Gilt für:

Siehe auch