SqlCommandBuilder Classe

Définition

Génère automatiquement des commandes à table unique utilisées pour harmoniser les modifications apportées à DataSet avec la base de données SQL Server associée.Automatically generates single-table commands that are used to reconcile changes made to a DataSet with the associated SQL Server database. Cette classe ne peut pas être héritée.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
Héritage
SqlCommandBuilder

Exemples

L’exemple suivant utilise SqlCommand, SqlConnectionainsi que SqlDataAdapter , pour sélectionner des lignes d’une source de données.The following example uses the SqlCommand, along SqlDataAdapter and SqlConnection, to select rows from a data source. L’exemple reçoit une chaîne de connexion, une chaîne de requête qui est une instruction Transact-SQL SELECT et une chaîne qui est le nom de la table de base de données.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. L’exemple crée ensuite un 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

Remarques

Ne génère pas automatiquement les instructions Transact-SQL requises pour harmoniser les modifications apportées DataSet à un avec l’instance associée de 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. Toutefois, vous pouvez créer un SqlCommandBuilder objet pour générer automatiquement des instructions Transact-SQL pour les mises à jour d’une seule table si SelectCommand vous définissez la SqlDataAdapterpropriété de.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. Ensuite, toutes les instructions Transact-SQL supplémentaires que vous ne définissez pas sont générées SqlCommandBuilderpar.Then, any additional Transact-SQL statements that you do not set are generated by the SqlCommandBuilder.

S’inscrit lui-même en tant qu’écouteur pour RowUpdating les événements chaque DataAdapter fois que vous définissez la propriété. SqlCommandBuilderThe SqlCommandBuilder registers itself as a listener for RowUpdating events whenever you set the DataAdapter property. Vous ne pouvez associer qu' SqlDataAdapter un SqlCommandBuilder seul objet ou entre eux en même temps.You can only associate one SqlDataAdapter or SqlCommandBuilder object with each other at one time.

Pour générer des instructions INSERT, Update ou Delete, le SqlCommandBuilder utilise la SelectCommand propriété pour récupérer automatiquement un jeu de métadonnées requis.To generate INSERT, UPDATE, or DELETE statements, the SqlCommandBuilder uses the SelectCommand property to retrieve a required set of metadata automatically. Si vous modifiez la SelectCommand après la récupération des métadonnées, par exemple après la première mise à jour, vous devez RefreshSchema appeler la méthode pour mettre à jour les métadonnées.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 doit aussi retourner au moins une clé primaire ou une colonne unique.The SelectCommand must also return at least one primary key or unique column. Si aucun n’est présent, une exception InvalidOperation est générée et les commandes ne sont pas générées.If none are present, an InvalidOperation exception is generated, and the commands are not generated.

Connection SelectCommandUtilise également les propriétés, CommandTimeout etTransaction référencées par le. SqlCommandBuilderThe SqlCommandBuilder also uses the Connection, CommandTimeout, and Transaction properties referenced by the SelectCommand. L’utilisateur doit appeler RefreshSchema si une ou plusieurs de ces propriétés sont modifiées, ou si le SelectCommand lui-même est remplacé.The user should call RefreshSchema if one or more of these properties are modified, or if the SelectCommand itself is replaced. Dans le InsertCommandcas UpdateCommandcontraire, DeleteCommand les propriétés, et conservent leurs valeurs précédentes.Otherwise the InsertCommand, UpdateCommand, and DeleteCommand properties retain their previous values.

Si vous appelez Dispose, la SqlCommandBuilder SqlDataAdapterest dissociée de, et les commandes générées ne sont plus utilisées.If you call Dispose, the SqlCommandBuilder is disassociated from the SqlDataAdapter, and the generated commands are no longer used.

Constructeurs

SqlCommandBuilder()

Initialise une nouvelle instance de la classe SqlCommandBuilder.Initializes a new instance of the SqlCommandBuilder class.

SqlCommandBuilder(SqlDataAdapter)

Initialise une nouvelle instance de la classe SqlCommandBuilder avec l'objet SqlDataAdapter associé.Initializes a new instance of the SqlCommandBuilder class with the associated SqlDataAdapter object.

Propriétés

CanRaiseEvents

Obtient une valeur qui indique si le composant peut déclencher un événement.Gets a value indicating whether the component can raise an event.

(Hérité de Component)
CatalogLocation

Définit ou obtient le CatalogLocation d'une instance de la classe SqlCommandBuilder.Sets or gets the CatalogLocation for an instance of the SqlCommandBuilder class.

CatalogSeparator

Définit ou obtient une chaîne utilisée comme séparateur de catalogue pour une instance de la classe SqlCommandBuilder.Sets or gets a string used as the catalog separator for an instance of the SqlCommandBuilder class.

Container

Obtient le IContainer qui contient Component.Gets the IContainer that contains the Component.

(Hérité de Component)
DataAdapter

Obtient ou définit un objet SqlDataAdapter pour lequel les instructions Transact-SQL sont automatiquement générées.Gets or sets a SqlDataAdapter object for which Transact-SQL statements are automatically generated.

DesignMode

Obtient une valeur qui indique si Component est actuellement en mode design.Gets a value that indicates whether the Component is currently in design mode.

(Hérité de Component)
Events

Obtient la liste des gestionnaires d'événements attachés à ce Component.Gets the list of event handlers that are attached to this Component.

(Hérité de Component)
QuotePrefix

Obtient ou définit le ou les caractères de début à utiliser lors de la spécification d'objets de base de données SQL Server, tels que des tables ou colonnes, dont les noms contiennent des caractères tels que des espaces ou des jetons réservés.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

Obtient ou définit le ou les caractères de fin à utiliser lors de la spécification d'objets de base de données SQL Server, tels que des tables ou colonnes, dont les noms contiennent des caractères tels que des espaces ou des jetons réservés.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

Obtient ou définit le caractère à utiliser pour le séparateur entre l'identificateur de schéma et tout autre identificateur.Gets or sets the character to be used for the separator between the schema identifier and any other identifiers.

Site

Obtient ou définit le ISite de Component.Gets or sets the ISite of the Component.

(Hérité de Component)

Méthodes

CreateObjRef(Type)

Crée un objet contenant toutes les informations appropriées requises pour générer un proxy permettant de communiquer avec un objet distant.Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.

(Hérité de MarshalByRefObject)
DeriveParameters(SqlCommand)

Récupère les informations sur les paramètres à partir de la procédure stockée spécifiée dans SqlCommand et remplit la collection Parameters de l'objet SqlCommand spécifié.Retrieves parameter information from the stored procedure specified in the SqlCommand and populates the Parameters collection of the specified SqlCommand object.

Dispose()

Libère toutes les ressources utilisées par Component.Releases all resources used by the Component.

(Hérité de Component)
Dispose(Boolean)

Libère les ressources non managées utilisées par Component et libère éventuellement les ressources managées.Releases the unmanaged resources used by the Component and optionally releases the managed resources.

(Hérité de Component)
Equals(Object)

Détermine si l'objet spécifié est identique à l'objet actuel.Determines whether the specified object is equal to the current object.

(Hérité de Object)
GetDeleteCommand()

Obtient l'objet SqlCommand généré automatiquement, qui est requis pour effectuer des suppressions au niveau de la base de données.Gets the automatically generated SqlCommand object required to perform deletions on the database.

GetDeleteCommand(Boolean)

Obtient l'objet SqlCommand généré automatiquement, qui est requis pour effectuer des suppressions au niveau de la base de données.Gets the automatically generated SqlCommand object that is required to perform deletions on the database.

GetHashCode()

Fait office de fonction de hachage par défaut.Serves as the default hash function.

(Hérité de Object)
GetInsertCommand()

Obtient l'objet SqlCommand généré automatiquement, qui est requis pour effectuer des suppressions au niveau de la base de données.Gets the automatically generated SqlCommand object required to perform insertions on the database.

GetInsertCommand(Boolean)

Obtient l'objet SqlCommand généré automatiquement, qui est requis pour effectuer des insertions au niveau de la base de données.Gets the automatically generated SqlCommand object that is required to perform insertions on the database.

GetLifetimeService()

Récupère l'objet de service de durée de vie en cours qui contrôle la stratégie de durée de vie de cette instance.Retrieves the current lifetime service object that controls the lifetime policy for this instance.

(Hérité de MarshalByRefObject)
GetService(Type)

Retourne un objet qui représente un service fourni par Component ou par son Container.Returns an object that represents a service provided by the Component or by its Container.

(Hérité de Component)
GetType()

Obtient le Type de l'instance actuelle.Gets the Type of the current instance.

(Hérité de Object)
GetUpdateCommand()

Obtient l'objet SqlCommand généré automatiquement, qui est requis pour effectuer des mises à jour au niveau de la base de données.Gets the automatically generated SqlCommand object required to perform updates on the database.

GetUpdateCommand(Boolean)

Obtient l'objet SqlCommand généré automatiquement, qui est requis pour effectuer des mises à jour au niveau de la base de données.Gets the automatically generated SqlCommand object required to perform updates on the database.

InitializeLifetimeService()

Obtient un objet de service de durée de vie pour contrôler la stratégie de durée de vie de cette instance.Obtains a lifetime service object to control the lifetime policy for this instance.

(Hérité de MarshalByRefObject)
MemberwiseClone()

Crée une copie superficielle de l'objet Object actuel.Creates a shallow copy of the current Object.

(Hérité de Object)
MemberwiseClone(Boolean)

Crée une copie superficielle de l'objet MarshalByRefObject actuel.Creates a shallow copy of the current MarshalByRefObject object.

(Hérité de MarshalByRefObject)
QuoteIdentifier(String)

À partir d'un identificateur sans guillemets dans le cas d'un catalogue correct, retourne la forme correcte de cet identificateur entre guillemets.Given an unquoted identifier in the correct catalog case, returns the correct quoted form of that identifier. Cela inclut d'effectuer une séquence d'échappement correcte pour les guillemets incorporés dans l'identificateur.This includes correctly escaping any embedded quotes in the identifier.

RefreshSchema()

Efface les commandes associées à ce générateur de commandes.Clears the commands that are associated with this command builder.

ToString()

Retourne un String contenant le nom du Component, s’il en existe un.Returns a String containing the name of the Component, if any. Cette méthode ne doit pas être remplacée.This method should not be overridden.

(Hérité de Component)
UnquoteIdentifier(String)

Muni d'un identificateur entre guillemets, retourne la forme de cet identificateur sans guillemets.Given a quoted identifier, returns the correct unquoted form of that identifier. Cela inclut de placer correctement tous les guillemets incorporés dans l'identificateur hors d'une séquence d'échappement.This includes correctly unescaping any embedded quotes in the identifier.

Événements

Disposed

Se produit lorsque le composant est supprimé par un appel à la méthode Dispose().Occurs when the component is disposed by a call to the Dispose() method.

(Hérité de Component)

S’applique à

Voir aussi