SqlCommandBuilder Clase

Definición

Genera automáticamente comandos de tabla única que se utilizan para conciliar los cambios realizados en un objeto DataSet con la base de datos de SQL Server asociada.Automatically generates single-table commands that are used to reconcile changes made to a DataSet with the associated SQL Server database. No se puede heredar esta clase.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
Herencia
Herencia
SqlCommandBuilder

Ejemplos

En el ejemplo siguiente se usa el SqlCommand, junto SqlDataAdapter y SqlConnection, para seleccionar las filas de un origen de datos.The following example uses the SqlCommand, along SqlDataAdapter and SqlConnection, to select rows from a data source. En el ejemplo se pasa una cadena de conexión, una cadena de consulta que es una instrucción SELECT de Transact-SQL, y una cadena que es el nombre de la tabla de base de datos.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. A continuación, en el ejemplo se crea 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

Comentarios

El SqlDataAdapter no genera automáticamente las instrucciones Transact-SQL necesarias para conciliar los cambios realizados en un DataSet con la instancia asociada de 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. Sin embargo, puede crear un objeto SqlCommandBuilder para generar automáticamente instrucciones Transact-SQL para las actualizaciones de tabla única si establece la propiedad SelectCommand de la 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. A continuación, el SqlCommandBuildergenera las instrucciones Transact-SQL adicionales que no establezca.Then, any additional Transact-SQL statements that you do not set are generated by the SqlCommandBuilder.

El SqlCommandBuilder se registra como un agente de escucha para los eventos de RowUpdating siempre que se establece la propiedad DataAdapter.The SqlCommandBuilder registers itself as a listener for RowUpdating events whenever you set the DataAdapter property. Solo puede asociar una SqlDataAdapter o SqlCommandBuilder objeto entre sí de una vez.You can only associate one SqlDataAdapter or SqlCommandBuilder object with each other at one time.

Para generar instrucciones INSERT, UPDATE o DELETE, el SqlCommandBuilder utiliza la propiedad SelectCommand para recuperar automáticamente un conjunto de metadatos necesario.To generate INSERT, UPDATE, or DELETE statements, the SqlCommandBuilder uses the SelectCommand property to retrieve a required set of metadata automatically. Si cambia el SelectCommand una vez recuperados los metadatos, como después de la primera actualización, debe llamar al método RefreshSchema para actualizar los metadatos.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 también debe devolver como mínimo una clave principal o una columna única.The SelectCommand must also return at least one primary key or unique column. Si no hay ninguno presente, se genera una excepción InvalidOperation y no se generan los comandos.If none are present, an InvalidOperation exception is generated, and the commands are not generated.

En el SqlCommandBuilder también se usan las propiedades Connection, CommandTimeouty Transaction a las que hace referencia el SelectCommand.The SqlCommandBuilder also uses the Connection, CommandTimeout, and Transaction properties referenced by the SelectCommand. El usuario debe llamar a RefreshSchema si se modifican una o varias de estas propiedades, o si se reemplaza el SelectCommand mismo.The user should call RefreshSchema if one or more of these properties are modified, or if the SelectCommand itself is replaced. De lo contrario, las propiedades InsertCommand, UpdateCommandy DeleteCommand conservan sus valores anteriores.Otherwise the InsertCommand, UpdateCommand, and DeleteCommand properties retain their previous values.

Si llama a Dispose, el SqlCommandBuilder se desasocia de la SqlDataAdaptery ya no se usan los comandos generados.If you call Dispose, the SqlCommandBuilder is disassociated from the SqlDataAdapter, and the generated commands are no longer used.

Constructores

SqlCommandBuilder()

Inicializa una nueva instancia de la clase SqlCommandBuilder.Initializes a new instance of the SqlCommandBuilder class.

SqlCommandBuilder(SqlDataAdapter)

Inicializa una nueva instancia de la clase SqlCommandBuilder con el objeto SqlDataAdapter asociado.Initializes a new instance of the SqlCommandBuilder class with the associated SqlDataAdapter object.

Propiedades

CanRaiseEvents

Obtiene un valor que indica si el componente puede generar un evento.Gets a value indicating whether the component can raise an event.

(Heredado de Component)
CatalogLocation

Obtiene o establece el objeto CatalogLocation para una instancia de la clase SqlCommandBuilder.Gets or sets the CatalogLocation for an instance of the SqlCommandBuilder class.

CatalogSeparator

Obtiene o establece una cadena que se usa como separador de catálogo para una instancia de la clase SqlCommandBuilder.Gets or sets a string used as the catalog separator for an instance of the SqlCommandBuilder class.

ConflictOption

Especifica qué ConflictOption va a utilizar DbCommandBuilder.Specifies which ConflictOption is to be used by the DbCommandBuilder.

(Heredado de DbCommandBuilder)
Container

Obtiene la interfaz IContainer que contiene la clase Component.Gets the IContainer that contains the Component.

(Heredado de Component)
DataAdapter

Obtiene o establece un objeto SqlDataAdapter para el que se generan automáticamente instrucciones de Transact-SQL.Gets or sets a SqlDataAdapter object for which Transact-SQL statements are automatically generated.

DesignMode

Obtiene un valor que indica si Component está actualmente en modo de diseño.Gets a value that indicates whether the Component is currently in design mode.

(Heredado de Component)
Events

Obtiene la lista de controladores de eventos asociados a Component.Gets the list of event handlers that are attached to this Component.

(Heredado de Component)
QuotePrefix

Obtiene o establece el carácter o caracteres iniciales que se van a utilizar para especificar objetos de base de datos de SQL Server, por ejemplo, tablas o columnas, cuyos nombres contengan caracteres como espacios o símbolos (tokens) reservados.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

Obtiene o establece el carácter o caracteres finales que se utilizan para especificar objetos de base de datos de SQL Server, por ejemplo, tablas o columnas, cuyos nombres contienen caracteres como espacios o símbolos (tokens) reservados.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

Obtiene o establece el carácter que se va a utilizar para el separador entre el identificador de esquema y cualquier otro identificador.Gets or sets the character to be used for the separator between the schema identifier and any other identifiers.

SetAllValues

Especifica si en una instrucción de actualización se incluyen todos los valores de columna o sólo los que han cambiado.Specifies whether all column values in an update statement are included or only changed ones.

(Heredado de DbCommandBuilder)
Site

Obtiene o establece el ISite de Component.Gets or sets the ISite of the Component.

(Heredado de Component)

Métodos

ApplyParameterInfo(DbParameter, DataRow, StatementType, Boolean)

Permite que la implementación del proveedor de la clase DbCommandBuilder controle propiedades de parámetro adicionales.Allows the provider implementation of the DbCommandBuilder class to handle additional parameter properties.

(Heredado de DbCommandBuilder)
CreateObjRef(Type)

Crea un objeto que contiene toda la información relevante necesaria para generar un proxy utilizado para comunicarse con un objeto remoto.Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.

(Heredado de MarshalByRefObject)
DeriveParameters(SqlCommand)

Recupera información de parámetro del procedimiento almacenado especificado en SqlCommand y rellena la colección de Parameters del objeto SqlCommand especificado.Retrieves parameter information from the stored procedure specified in the SqlCommand and populates the Parameters collection of the specified SqlCommand object.

Dispose()

Libera todos los recursos que utiliza Component.Releases all resources used by the Component.

(Heredado de Component)
Dispose(Boolean)

Libera los recursos no administrados utilizados por DbCommandBuilder y, opcionalmente, libera también los recursos administrados.Releases the unmanaged resources used by the DbCommandBuilder and optionally releases the managed resources.

(Heredado de DbCommandBuilder)
Dispose(Boolean)

Libera los recursos no administrados utilizados por Component y, opcionalmente, libera también los recursos administrados.Releases the unmanaged resources used by the Component and optionally releases the managed resources.

(Heredado de Component)
Equals(Object)

Determina si el objeto especificado es igual al objeto actual.Determines whether the specified object is equal to the current object.

(Heredado de Object)
GetDeleteCommand()

Obtiene el objeto SqlCommand generado automáticamente que es necesario para realizar eliminaciones en la base de datos.Gets the automatically generated SqlCommand object required to perform deletions on the database.

GetDeleteCommand(Boolean)

Obtiene el objeto SqlCommand generado automáticamente que es necesario para realizar eliminaciones en la base de datos.Gets the automatically generated SqlCommand object that is required to perform deletions on the database.

GetHashCode()

Sirve como la función hash predeterminada.Serves as the default hash function.

(Heredado de Object)
GetInsertCommand()

Obtiene el objeto SqlCommand generado automáticamente que es necesario para realizar inserciones en la base de datos.Gets the automatically generated SqlCommand object required to perform insertions on the database.

GetInsertCommand(Boolean)

Obtiene el objeto SqlCommand generado automáticamente que es necesario para realizar inserciones en la base de datos.Gets the automatically generated SqlCommand object that is required to perform insertions on the database.

GetLifetimeService()

Recupera el objeto de servicio de duración actual que controla la directiva de duración de esta instancia.Retrieves the current lifetime service object that controls the lifetime policy for this instance.

(Heredado de MarshalByRefObject)
GetParameterName(Int32)

Devuelve el nombre del parámetro especificado con el formato @p#.Returns the name of the specified parameter in the format of @p#. Utilícelo al crear un generador de comandos personalizado.Use when building a custom command builder.

(Heredado de DbCommandBuilder)
GetParameterName(String)

Devuelve el nombre completo del parámetro, a partir de su nombre parcial.Returns the full parameter name, given the partial parameter name.

(Heredado de DbCommandBuilder)
GetParameterPlaceholder(Int32)

Devuelve el marcador de posición para el parámetro en la instrucción SQL asociada.Returns the placeholder for the parameter in the associated SQL statement.

(Heredado de DbCommandBuilder)
GetSchemaTable(DbCommand)

Devuelve la tabla de esquema para DbCommandBuilder.Returns the schema table for the DbCommandBuilder.

(Heredado de DbCommandBuilder)
GetService(Type)

Devuelve un objeto que representa el servicio suministrado por Component o por Container.Returns an object that represents a service provided by the Component or by its Container.

(Heredado de Component)
GetType()

Obtiene el Type de la instancia actual.Gets the Type of the current instance.

(Heredado de Object)
GetUpdateCommand()

Obtiene el objeto SqlCommand generado automáticamente que es necesario para realizar actualizaciones en la base de datos.Gets the automatically generated SqlCommand object required to perform updates on the database.

GetUpdateCommand(Boolean)

Obtiene el objeto SqlCommand generado automáticamente que es necesario para realizar actualizaciones en la base de datos.Gets the automatically generated SqlCommand object required to perform updates on the database.

InitializeCommand(DbCommand)

Restablece las propiedades CommandTimeout, Transaction, CommandType y UpdateRowSource en el objeto DbCommand.Resets the CommandTimeout, Transaction, CommandType, and UpdateRowSource properties on the DbCommand.

(Heredado de DbCommandBuilder)
InitializeLifetimeService()

Obtiene un objeto de servicio de duración para controlar la directiva de duración de esta instancia.Obtains a lifetime service object to control the lifetime policy for this instance.

(Heredado de MarshalByRefObject)
MemberwiseClone()

Crea una copia superficial del Object actual.Creates a shallow copy of the current Object.

(Heredado de Object)
MemberwiseClone(Boolean)

Crea una copia superficial del objeto MarshalByRefObject actual.Creates a shallow copy of the current MarshalByRefObject object.

(Heredado de MarshalByRefObject)
QuoteIdentifier(String)

Dado un identificador sin comillas en el caso de un catálogo correcto, devuelve el formato correcto del entrecomillado de ese identificador.Given an unquoted identifier in the correct catalog case, returns the correct quoted form of that identifier. Incluye una secuencia de escape correcta de las comillas incrustadas que pueda haber en el identificador.This includes correctly escaping any embedded quotes in the identifier.

RefreshSchema()

Borra los comandos asociados a este generador de comandos.Clears the commands that are associated with this command builder.

RefreshSchema()

Borra los comandos asociados a este DbCommandBuilder.Clears the commands associated with this DbCommandBuilder.

(Heredado de DbCommandBuilder)
RowUpdatingHandler(RowUpdatingEventArgs)

Agrega un controlador de eventos para el evento RowUpdating.Adds an event handler for the RowUpdating event.

(Heredado de DbCommandBuilder)
SetRowUpdatingHandler(DbDataAdapter)

Registra el objeto DbCommandBuilder para controlar el evento RowUpdating de un objeto DbDataAdapter.Registers the DbCommandBuilder to handle the RowUpdating event for a DbDataAdapter.

(Heredado de DbCommandBuilder)
ToString()

Devuelve una String que contiene el nombre del Component, si existe.Returns a String containing the name of the Component, if any. Este método no se debe invalidar.This method should not be overridden.

(Heredado de Component)
UnquoteIdentifier(String)

Dado in identificador entre comillas, devuelve el formato correcto sin comillas de ese identificador.Given a quoted identifier, returns the correct unquoted form of that identifier. Incluye una secuencia sin escape correcta de las comillas incrustadas que pueda haber en el identificador.This includes correctly unescaping any embedded quotes in the identifier.

Eventos

Disposed

Tiene lugar cuando una llamada elimina el componente mediante una llamada al método Dispose().Occurs when the component is disposed by a call to the Dispose() method.

(Heredado de Component)

Se aplica a

Consulte también: