Export (0) Print
Expand All

OdbcCommandBuilder Class

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

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

public sealed class OdbcCommandBuilder : DbCommandBuilder

The OdbcCommandBuilder type exposes the following members.

  NameDescription
Public methodOdbcCommandBuilder()Initializes a new instance of the OdbcCommandBuilder class.
Public methodOdbcCommandBuilder(OdbcDataAdapter)Initializes a new instance of the OdbcCommandBuilder class with the associated OdbcDataAdapter object.
Top

  NameDescription
Public propertyCatalogLocationSets or gets the CatalogLocation for an instance of the DbCommandBuilder class. (Inherited from DbCommandBuilder.)
Public propertyCatalogSeparatorSets or gets a string used as the catalog separator for an instance of the DbCommandBuilder class. (Inherited from DbCommandBuilder.)
Public propertyConflictOptionSpecifies which ConflictOption is to be used by the DbCommandBuilder. (Inherited from DbCommandBuilder.)
Public propertyContainerGets the IContainer that contains the Component. (Inherited from Component.)
Public propertyDataAdapterGets or sets an OdbcDataAdapter object for which this OdbcCommandBuilder object will generate SQL statements.
Public propertyQuotePrefixGets 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.)
Public propertyQuoteSuffixGets 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.)
Public propertySchemaSeparatorGets or sets the character to be used for the separator between the schema identifier and any other identifiers. (Inherited from DbCommandBuilder.)
Public propertySetAllValuesSpecifies whether all column values in an update statement are included or only changed ones. (Inherited from DbCommandBuilder.)
Public propertySiteGets or sets the ISite of the Component. (Inherited from Component.)
Top

  NameDescription
Public methodCreateObjRefCreates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
Public methodStatic memberDeriveParametersRetrieves parameter information from the stored procedure specified in the OdbcCommand and populates the Parameters collection of the specified OdbcCommand object.
Public methodDispose()Releases all resources used by the Component. (Inherited from Component.)
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodGetDeleteCommand()Gets the automatically generated OdbcCommand object required to perform deletions at the data source.
Public methodGetDeleteCommand(Boolean)Gets the automatically generated OdbcCommand object required to perform deletions at the data source.
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetInsertCommand()Gets the automatically generated OdbcCommand object required to perform insertions at the data source.
Public methodGetInsertCommand(Boolean)Gets the automatically generated OdbcCommand object required to perform insertions at the data source.
Public methodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodGetUpdateCommand()Gets the automatically generated OdbcCommand object required to perform updates at the data source.
Public methodGetUpdateCommand(Boolean)Gets the automatically generated OdbcCommand object required to perform updates at the data source.
Public methodInitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Public methodQuoteIdentifier(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).)
Public methodQuoteIdentifier(String, OdbcConnection)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.
Public methodRefreshSchemaClears the commands associated with this DbCommandBuilder. (Inherited from DbCommandBuilder.)
Public methodToStringReturns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component.)
Public methodUnquoteIdentifier(String)Given a quoted identifier, returns the correct unquoted form of that identifier, including correctly unescaping any embedded quotes in the identifier. (Overrides DbCommandBuilder.UnquoteIdentifier(String).)
Public methodUnquoteIdentifier(String, OdbcConnection)Given a quoted identifier, returns the correct unquoted form of that identifier, including correctly unescaping any embedded quotes in the identifier.
Top

  NameDescription
Public eventDisposedOccurs when the component is disposed by a call to the Dispose method. (Inherited from Component.)
Top

The OdbcDataAdapter does not automatically generate the SQL statements required to reconcile changes made to a DataSet associated with the data source. However, you can create an OdbcCommandBuilder object that generates SQL statements for single-table updates by setting the SelectCommand property of the OdbcDataAdapter. The OdbcCommandBuilder then generates any additional SQL statements that you do not set.

The relationship between an OdbcDataAdapter and its corresponding OdbcCommandBuilder is always one-to-one. To create this correspondence, you set the OdbcDataAdapter property of the OdbcCommandBuilder object. This causes the OdbcCommandBuilder to register itself as a listener, which produces the output of RowUpdating events that affect the DataSet.

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

NoteNote

If the SELECT statement assigned to the SelectCommand property uses aliased column names, the resulting INSERT, UPDATE, and DELETE statements may be inaccurate or fail. If the underlying ODBC driver cannot provide the appropriate base column name for the alias column name (using the SQL_DESC_BASE_COLUMN_NAME value of SQLColAttribute), the alias name could be used in the generated INSERT, UPDATE, and DELETE statements. For example, the Microsoft ODBC Driver for Oracle returns the alias name as the base column name. Therefore, the generated INSERT, UPDATE, and DELETE statements would cause errors.

The OdbcCommandBuilder 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 value of the SelectCommand property itself is changed. Otherwise the InsertCommand, UpdateCommand, and DeleteCommand properties retain their previous values.

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

The following example uses OdbcCommand, together with OdbcDataAdapter and OdbcConnection, 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 OdbcCommandBuilder.

public static DataSet SelectOdbcSrvRows(string connectionString,
    string queryString, string tableName)
{
    DataSet dataSet = new DataSet();
    using (OdbcConnection connection = new OdbcConnection(connectionString))
    {
        OdbcDataAdapter adapter = new OdbcDataAdapter();
        adapter.SelectCommand =
            new OdbcCommand(queryString, connection);
        OdbcCommandBuilder builder =
            new OdbcCommandBuilder(adapter);

        connection.Open();

        adapter.Fill(dataSet, tableName);

        //code to modify data in DataSet here 

        //Without the OdbcCommandBuilder this line would fail
        adapter.Update(dataSet, tableName);
    }
    return dataSet;
}

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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