OleDbCommandBuilder Class

OleDbCommandBuilder Class

 

Automatically generates single-table commands that are used to reconcile changes made to a DataSet with the associated database. This class cannot be inherited.

Namespace:   System.Data.OleDb
Assembly:  System.Data (in System.Data.dll)

System.Object
  System.MarshalByRefObject
    System.ComponentModel.Component
      System.Data.Common.DbCommandBuilder
        System.Data.OleDb.OleDbCommandBuilder

public sealed class OleDbCommandBuilder : DbCommandBuilder

NameDescription
System_CAPS_pubmethodOleDbCommandBuilder()

Initializes a new instance of the OleDbCommandBuilder class.

System_CAPS_pubmethodOleDbCommandBuilder(OleDbDataAdapter)

Initializes a new instance of the OleDbCommandBuilder class with the associated OleDbDataAdapter object.

NameDescription
System_CAPS_pubpropertyCatalogLocation

Sets or gets the CatalogLocation for an instance of the DbCommandBuilder class.(Inherited from DbCommandBuilder.)

System_CAPS_pubpropertyCatalogSeparator

Sets or gets a string used as the catalog separator for an instance of the DbCommandBuilder class.(Inherited from DbCommandBuilder.)

System_CAPS_pubpropertyConflictOption

Specifies which ConflictOption is to be used by the DbCommandBuilder.(Inherited from DbCommandBuilder.)

System_CAPS_pubpropertyContainer

Gets the IContainer that contains the Component.(Inherited from Component.)

System_CAPS_pubpropertyDataAdapter

Gets or sets an OleDbDataAdapter object for which SQL statements are automatically generated.

System_CAPS_pubpropertyQuotePrefix

Gets or sets the beginning character or characters to use when specifying database objects (for example, tables or columns) whose names contain characters such as spaces or reserved tokens.(Inherited from DbCommandBuilder.)

System_CAPS_pubpropertyQuoteSuffix

Gets or sets the ending character or characters to use when specifying database objects (for example, tables or columns) whose names contain characters such as spaces or reserved tokens.(Inherited from DbCommandBuilder.)

System_CAPS_pubpropertySchemaSeparator

Gets or sets the character to be used for the separator between the schema identifier and any other identifiers.(Inherited from DbCommandBuilder.)

System_CAPS_pubpropertySetAllValues

Specifies whether all column values in an update statement are included or only changed ones.(Inherited from DbCommandBuilder.)

System_CAPS_pubpropertySite

Gets or sets the ISite of the Component.(Inherited from Component.)

NameDescription
System_CAPS_pubmethodCreateObjRef(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.)

System_CAPS_pubmethodSystem_CAPS_staticDeriveParameters(OleDbCommand)

Retrieves parameter information from the stored procedure specified in the OleDbCommand and populates the Parameters collection of the specified OleDbCommand object.

System_CAPS_pubmethodDispose()

Releases all resources used by the Component.(Inherited from Component.)

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_pubmethodGetDeleteCommand()

Gets the automatically generated OleDbCommand object required to perform deletions at the data source.

System_CAPS_pubmethodGetDeleteCommand(Boolean)

Gets the automatically generated OleDbCommand object required to perform deletions at the data source.

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetInsertCommand()

Gets the automatically generated OleDbCommand object required to perform insertions at the data source.

System_CAPS_pubmethodGetInsertCommand(Boolean)

Gets the automatically generated OleDbCommand object required to perform insertions at the data source.

System_CAPS_pubmethodGetLifetimeService()

Retrieves the current lifetime service object that controls the lifetime policy for this instance.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodGetUpdateCommand()

Gets the automatically generated OleDbCommand object required to perform updates at the data source.

System_CAPS_pubmethodGetUpdateCommand(Boolean)

Gets the automatically generated OleDbCommand object required to perform updates at the data source, optionally using columns for parameter names.

System_CAPS_pubmethodInitializeLifetimeService()

Obtains a lifetime service object to control the lifetime policy for this instance.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodQuoteIdentifier(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.(Overrides DbCommandBuilder.QuoteIdentifier(String).)

System_CAPS_pubmethodQuoteIdentifier(String, OleDbConnection)

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.

System_CAPS_pubmethodRefreshSchema()

Clears the commands associated with this DbCommandBuilder.(Inherited from DbCommandBuilder.)

System_CAPS_pubmethodToString()

Returns a String containing the name of the Component, if any. This method should not be overridden.(Inherited from Component.)

System_CAPS_pubmethodUnquoteIdentifier(String)

Given a quoted identifier, returns the correct unquoted form of that identifier. This includes correctly un-escaping any embedded quotes in the identifier.(Overrides DbCommandBuilder.UnquoteIdentifier(String).)

System_CAPS_pubmethodUnquoteIdentifier(String, OleDbConnection)

Given a quoted identifier, returns the correct unquoted form of that identifier. This includes correctly un-escaping any embedded quotes in the identifier.

NameDescription
System_CAPS_pubeventDisposed

Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component.)

The OleDbDataAdapter does not automatically generate the SQL statements required to reconcile changes made to a DataSet with the associated data source. However, you can create an OleDbCommandBuilder object to automatically generate SQL statements for single-table updates if you set the SelectCommand property of the OleDbDataAdapter. Then, any additional SQL statements that you do not set are generated by the OleDbCommandBuilder.

The OleDbCommandBuilder registers itself as a listener for RowUpdating events whenever you set the DataAdapter property. You can only associate one OleDbDataAdapter or OleDbCommandBuilder object with each other at one time.

To generate INSERT, UPDATE, or DELETE statements, the OleDbCommandBuilder uses the SelectCommand property to retrieve a required set of metadata automatically. If you change the SelectCommand after the metadata is retrieved, such as after the first update, you should call the RefreshSchema method to update the metadata.

The OleDbCommandBuilder also uses the Connection, CommandTimeout, and Transaction properties referenced by the SelectCommand. The user should call RefreshSchema if one or more of these properties are modified, or if the SelectCommand itself is replaced. Otherwise the InsertCommand, UpdateCommand, and DeleteCommand properties retain their previous values.

If you call Dispose, the OleDbCommandBuilder is disassociated from the OleDbDataAdapter, and the generated commands are no longer used.

The following example uses the OleDbCommand, along OleDbDataAdapter and OleDbConnection, to select rows from a data source. The example is passed an initialized DataSet, a connection string, a query string that is an SQL SELECT statement, and a string that is the name of the data source table. The example then creates an OleDbCommandBuilder.

public static DataSet UpdateRows(string connectionString,
    string queryString, string tableName)
{
    DataSet dataSet = new DataSet();
    using (OleDbConnection connection = new OleDbConnection(connectionString))
    {
        OleDbDataAdapter adapter = new OleDbDataAdapter();
        adapter.SelectCommand = new OleDbCommand(queryString, connection);
        OleDbCommandBuilder cb = new OleDbCommandBuilder(adapter);

        connection.Open();

        adapter.Fill(dataSet, tableName);

        //code to modify data in DataSet here

        cb.GetDeleteCommand();
        //Without the OleDbCommandBuilder this line would fail
        adapter.Update(dataSet, tableName);

        connection.Close();
    }
    return dataSet;
}

.NET Framework
Available since 1.1

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show:
© 2016 Microsoft