This documentation is archived and is not being maintained.

IDataAdapter Interface

Allows an object to implement a DataAdapter, and represents a set of methods and mapping action-related properties that are used to fill and update a DataSet and update a data source.

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

public interface IDataAdapter

The IDataAdapter type exposes the following members.

Public propertySupported by the XNA FrameworkMissingMappingActionIndicates or specifies whether unmapped source tables or columns are passed with their source names in order to be filtered or to raise an error.
Public propertySupported by the XNA FrameworkMissingSchemaActionIndicates or specifies whether missing source tables, columns, and their relationships are added to the dataset schema, ignored, or cause an error to be raised.
Public propertySupported by the XNA FrameworkTableMappingsIndicates how a source table is mapped to a dataset table.

Public methodSupported by the XNA FrameworkFillAdds or updates rows in the DataSet to match those in the data source using the DataSet name, and creates a DataTable named "Table".
Public methodSupported by the XNA FrameworkFillSchemaAdds a DataTable named "Table" to the specified DataSet and configures the schema to match that in the data source based on the specified SchemaType.
Public methodSupported by the XNA FrameworkGetFillParametersGets the parameters set by the user when executing an SQL SELECT statement.
Public methodSupported by the XNA FrameworkUpdateCalls the respective INSERT, UPDATE, or DELETE statements for each inserted, updated, or deleted row in the specified DataSet from a DataTable named "Table".

The IDataAdapter interface allows an inheriting class to implement a DataAdapter class, which represents the bridge between a data source and a DataSet. For more information about DataAdapter classes, see Populating a DataSet from a DataAdapter (ADO.NET).

An application does not create an instance of the IDbDataAdapter interface directly, but implements an instance of a class that inherits IDbDataAdapter.

Classes that inherit IDataAdapter must implement the inherited members, and they typically define additional members to add provider-specific functionality. For example, the IDataAdapter interface defines a Fill method that takes a DataSet as a parameter. In turn, the OleDbDataAdapter class inherits the Fill method and also defines two additional overloads of the Fill method that take an ADO Recordset object as a parameter.

Notes to Implementers

To promote consistency among .NET Framework data providers, name the inheriting class in the form Prv DataAdapter where Prv is the uniform prefix given to all classes in a specific .NET Framework data provider namespace. For example, Sql is the prefix of the SqlDataAdapter class in the System.Data.SqlClient namespace.

When you inherit from the IDataAdapter interface, you should implement the following constructors:




Initializes a new instance of the PrvDataAdapter class.

PrvDataAdapter(PrvCommand selectCommand)

Initializes a new instance of the PrvDataAdapter class by using the specified SQL SELECT statement.

PrvDataAdapter(string selectCommandText, string selectConnectionString)

Initializes a new instance of the PrvDataAdapter class by using an SQL SELECT statement and a connection string.

PrvDataAdapter(string selectCommandText, PrvConnection selectConnection)

Initializes a new instance of the PrvDataAdapter class by using an SQL SELECT statement and a PrvConnection object.

The following example uses the derived classes, SqlCommand, SqlDataAdapter, and SqlConnection, to select records from a database. The filled DataSet is then returned. To do this, the method is passed an initialized DataSet, a connection string, and a query string that is a Transact-SQL SELECT statement.

private static DataSet SelectRows(DataSet dataset,
    string connectionString,string queryString) 
    using (SqlConnection connection = 
        new SqlConnection(connectionString))
        SqlDataAdapter adapter = new SqlDataAdapter();
        adapter.SelectCommand = new SqlCommand(
            queryString, connection);
        return dataset;

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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