Export (0) Print
Expand All

OdbcDataAdapter Class

Represents a set of data commands and a connection to a data source that are used to fill the DataSet and update the data source. This class cannot be inherited.

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

'Declaration
Public NotInheritable Class OdbcDataAdapter _
	Inherits DbDataAdapter _
	Implements IDbDataAdapter, IDataAdapter, ICloneable

The OdbcDataAdapter type exposes the following members.

  NameDescription
Public methodOdbcDataAdapterInitializes a new instance of the OdbcDataAdapter class.
Public methodOdbcDataAdapter(OdbcCommand)Initializes a new instance of the OdbcDataAdapter class with the specified SQL SELECT statement.
Public methodOdbcDataAdapter(String, OdbcConnection)Initializes a new instance of the OdbcDataAdapter class with an SQL SELECT statement and an OdbcConnection.
Public methodOdbcDataAdapter(String, String)Initializes a new instance of the OdbcDataAdapter class with an SQL SELECT statement and a connection string.
Top

  NameDescription
Public propertyAcceptChangesDuringFillGets or sets a value indicating whether AcceptChanges is called on a DataRow after it is added to the DataTable during any of the Fill operations. (Inherited from DataAdapter.)
Public propertyAcceptChangesDuringUpdateGets or sets whether AcceptChanges is called during a Update. (Inherited from DataAdapter.)
Public propertyContainerGets the IContainer that contains the Component. (Inherited from Component.)
Public propertyContinueUpdateOnErrorGets or sets a value that specifies whether to generate an exception when an error is encountered during a row update. (Inherited from DataAdapter.)
Public propertyDeleteCommandGets or sets an SQL statement or stored procedure used to delete records in the data source.
Protected propertyFillCommandBehaviorGets or sets the behavior of the command used to fill the data adapter. (Inherited from DbDataAdapter.)
Public propertyFillLoadOptionGets or sets the LoadOption that determines how the adapter fills the DataTable from the DbDataReader. (Inherited from DataAdapter.)
Public propertyInsertCommandGets or sets an SQL statement or stored procedure used to insert new records into the data source.
Public propertyMissingMappingActionDetermines the action to take when incoming data does not have a matching table or column. (Inherited from DataAdapter.)
Public propertyMissingSchemaActionDetermines the action to take when existing DataSet schema does not match incoming data. (Inherited from DataAdapter.)
Public propertyReturnProviderSpecificTypesGets or sets whether the Fill method should return provider-specific values or common CLS-compliant values. (Inherited from DataAdapter.)
Public propertySelectCommandGets or sets an SQL statement or stored procedure used to select records in the data source.
Public propertySiteGets or sets the ISite of the Component. (Inherited from Component.)
Public propertyTableMappingsGets a collection that provides the master mapping between a source table and a DataTable. (Inherited from DataAdapter.)
Public propertyUpdateBatchSizeGets or sets a value that enables or disables batch processing support, and specifies the number of commands that can be executed in a batch. (Inherited from DbDataAdapter.)
Public propertyUpdateCommandGets or sets an SQL statement or stored procedure used to update records in the data source.
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 methodDisposeReleases 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 methodFill(DataSet)Adds or refreshes rows in the DataSet. (Inherited from DbDataAdapter.)
Public methodFill(DataTable)Adds or refreshes rows in a specified range in the DataSet to match those in the data source using the DataTable name. (Inherited from DbDataAdapter.)
Public methodFill(DataSet, String)Adds or refreshes rows in the DataSet to match those in the data source using the DataSet and DataTable names. (Inherited from DbDataAdapter.)
Public methodFill(Int32, Int32, DataTable())Adds or refreshes rows in a DataTable to match those in the data source starting at the specified record and retrieving up to the specified maximum number of records. (Inherited from DbDataAdapter.)
Public methodFill(DataSet, Int32, Int32, String)Adds or refreshes rows in a specified range in the DataSet to match those in the data source using the DataSet and DataTable names. (Inherited from DbDataAdapter.)
Public methodFillSchema(DataSet, SchemaType)Adds a DataTable named "Table" to the specified DataSet and configures the schema to match that in the data source based on the specified SchemaType. (Inherited from DbDataAdapter.)
Public methodFillSchema(DataTable, SchemaType)Configures the schema of the specified DataTable based on the specified SchemaType. (Inherited from DbDataAdapter.)
Public methodFillSchema(DataSet, SchemaType, String)Adds a DataTable to the specified DataSet and configures the schema to match that in the data source based upon the specified SchemaType and DataTable. (Inherited from DbDataAdapter.)
Public methodGetFillParametersGets the parameters set by the user when executing an SQL SELECT statement. (Inherited from DbDataAdapter.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
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 methodInitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Public methodResetFillLoadOptionResets FillLoadOption to its default state and causes DataAdapter.Fill to honor AcceptChangesDuringFill. (Inherited from DataAdapter.)
Public methodShouldSerializeAcceptChangesDuringFillDetermines whether the AcceptChangesDuringFill property should be persisted. (Inherited from DataAdapter.)
Public methodShouldSerializeFillLoadOptionDetermines whether the FillLoadOption property should be persisted. (Inherited from DataAdapter.)
Public methodToStringReturns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component.)
Public methodUpdate(DataRow())Updates the values in the database by executing the respective INSERT, UPDATE, or DELETE statements for each inserted, updated, or deleted row in the specified array in the DataSet. (Inherited from DbDataAdapter.)
Public methodUpdate(DataSet)Updates the values in the database by executing the respective INSERT, UPDATE, or DELETE statements for each inserted, updated, or deleted row in the specified DataSet. (Inherited from DbDataAdapter.)
Public methodUpdate(DataTable)Updates the values in the database by executing the respective INSERT, UPDATE, or DELETE statements for each inserted, updated, or deleted row in the specified DataTable. (Inherited from DbDataAdapter.)
Public methodUpdate(DataSet, String)Updates the values in the database by executing the respective INSERT, UPDATE, or DELETE statements for each inserted, updated, or deleted row in the DataSet with the specified DataTable name. (Inherited from DbDataAdapter.)
Top

  NameDescription
Public eventDisposedOccurs when the component is disposed by a call to the Dispose method. (Inherited from Component.)
Public eventFillErrorReturned when an error occurs during a fill operation. (Inherited from DataAdapter.)
Public eventRowUpdatedOccurs during an update operation after a command is executed against the data source.
Public eventRowUpdatingOccurs during Update before a command is executed against the data source.
Top

  NameDescription
Explicit interface implemetationPrivate methodICloneable.CloneFor a description of this member, see ICloneable.Clone.
Explicit interface implemetationPrivate propertyIDataAdapter.TableMappingsIndicates how a source table is mapped to a dataset table. (Inherited from DataAdapter.)
Explicit interface implemetationPrivate propertyIDbDataAdapter.DeleteCommandFor a description of this member, see DeleteCommand.
Explicit interface implemetationPrivate propertyIDbDataAdapter.InsertCommandFor a description of this member, see InsertCommand.
Explicit interface implemetationPrivate propertyIDbDataAdapter.SelectCommandFor a description of this member, see SelectCommand.
Explicit interface implemetationPrivate propertyIDbDataAdapter.UpdateCommandFor a description of this member, see UpdateCommand.
Top

The OdbcDataAdapter serves as a bridge between a DataSet and data source for retrieving and saving data. The OdbcDataAdapter provides this bridge by using Fill to load data from the data source into the DataSet, and using Update to send changes made in the DataSet back to the data source.

When the OdbcDataAdapter fills a DataSet, it creates the required tables and columns for the returned data if they do not already exist. However, primary key information is not included in the implicitly created schema unless the MissingSchemaAction property is set to AddWithKey. You may also have the OdbcDataAdapter create the schema of the DataSet, including primary key information, before filling it with data using FillSchema. For more information, see Adding Existing Constraints to a DataSet.

NoteNote

When you call the Fill method on a data source that does not have a primary key column, the OdbcDataAdapter tries to promote the unique constraint column to the primary key. In the process, the OdbcDataAdapter marks the unique constraint as not nullable. This behavior works unless there is a null value in the unique constraint column. If there is a null value, the Fill method fails with a constraint violation. To avoid this situation, do not allow null values in the unique constraint column.

NoteNote

Due to the limitations of native ODBC drivers, only one DataTable is ever returned when you call FillSchema. This is true even when executing SQL batch statements from which multiple DataTable objects would be expected.

The OdbcDataAdapter also includes the SelectCommand, InsertCommand, DeleteCommand, UpdateCommand, and TableMappings properties to facilitate loading and updating of data.

The following example uses OdbcCommand, OdbcDataAdapter, and OdbcConnection to select records and populate a DataSet with the selected rows.

Public Function GetDataSetFromAdapter( _
    ByVal dataSet As DataSet, ByVal connectionString As String, _
    ByVal queryString As String) As DataSet

    Using connection As New OdbcConnection(connectionString)
        Dim adapter As New OdbcDataAdapter(queryString, connection)

        ' Open the connection and fill the DataSet. 
        Try
            connection.Open()
            adapter.Fill(dataSet)
        Catch ex As Exception
            Console.WriteLine(ex.Message)
        End Try 
        ' The connection is automatically closed when the 
        ' code exits the Using block. 
    End Using 

    Return dataSet
End Function

.NET Framework

Supported in: 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