SqlDataAdapter Class

Definition

Namespace:

System.Data.SqlClient

Assembly:

System.Data.dll

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

public ref class SqlDataAdapter sealed : System::Data::Common::DbDataAdapter, ICloneable

public sealed class SqlDataAdapter : System.Data.Common.DbDataAdapter, ICloneable

type SqlDataAdapter = class
    inherit DbDataAdapter
    interface IDbDataAdapter
    interface IDataAdapter
    interface ICloneable

Public NotInheritable Class SqlDataAdapter
Inherits DbDataAdapter
Implements ICloneable

Inheritance

Object

MarshalByRefObject

Component

DataAdapter

DbDataAdapter

SqlDataAdapter

Implements

IDataAdapter IDbDataAdapter ICloneable

Examples

The following example uses the SqlCommand, SqlDataAdapter, and SqlConnection to select records from a database and populate a DataSet with the selected rows. The filled DataSet is then returned. To accomplish 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);
        adapter.Fill(dataset);
        return dataset;
    }
}

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

    Using connection As New SqlConnection(connectionString)
        Dim adapter As New SqlDataAdapter()
        adapter.SelectCommand = New SqlCommand( _
            queryString, connection)
        adapter.Fill(dataSet)
        Return dataSet
    End Using
End Function

Remarks

The SqlDataAdapter, serves as a bridge between a DataSet and SQL Server for retrieving and saving data. The SqlDataAdapter provides this bridge by mapping Fill, which changes the data in the DataSet to match the data in the data source, and Update, which changes the data in the data source to match the data in the DataSet, using the appropriate Transact-SQL statements against the data source. The update is performed on a by-row basis. For every inserted, modified, and deleted row, the Update method determines the type of change that has been performed on it (Insert, Update, or Delete). Depending on the type of change, the Insert, Update, or Delete command template executes to propagate the modified row to the data source. When the SqlDataAdapter fills a DataSet, it creates the necessary 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 SqlDataAdapter 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.

SqlDataAdapter is used in conjunction with SqlConnection and SqlCommand to increase performance when connecting to a SQL Server database.

Note

If you are using SQL Server stored procedures to edit or delete data using a DataAdapter, make sure that you do not use SET NOCOUNT ON in the stored procedure definition. This causes the rows affected count returned to be zero, which the DataAdapter interprets as a concurrency conflict. In this event, a DBConcurrencyException will be thrown.

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

When an instance of SqlDataAdapter is created, the read/write properties are set to initial values. For a list of these values, see the SqlDataAdapter constructor.

The InsertCommand, DeleteCommand, and UpdateCommand are generic templates that are automatically filled with individual values from every modified row through the parameters mechanism.

For every column that you propagate to the data source on Update, a parameter should be added to the InsertCommand, UpdateCommand, or DeleteCommand. The SourceColumn property of the DbParameter object should be set to the name of the column. This setting indicates that the value of the parameter is not set manually, but is taken from the particular column in the currently processed row.

Note

An InvalidOperationException will occur if the Fill method is called and the table contains a user-defined type that is not available on the client computer. For more information, see CLR User-Defined Types.

Constructors

SqlDataAdapter()	Initializes a new instance of the SqlDataAdapter class.
SqlDataAdapter(SqlCommand)	Initializes a new instance of the SqlDataAdapter class with the specified SqlCommand as the SelectCommand property.
SqlDataAdapter(String, SqlConnection)	Initializes a new instance of the SqlDataAdapter class with a SelectCommand and a SqlConnection object.
SqlDataAdapter(String, String)	Initializes a new instance of the SqlDataAdapter class with a SelectCommand and a connection string.

Fields

DefaultSourceTableName

The default name used by the DataAdapter object for table mappings. (Inherited from DbDataAdapter)

Properties

AcceptChangesDuringFill	Gets 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)
AcceptChangesDuringUpdate	Gets or sets whether AcceptChanges() is called during a Update(DataSet). (Inherited from DataAdapter)
CanRaiseEvents	Gets a value indicating whether the component can raise an event. (Inherited from Component)
Container	Gets the IContainer that contains the Component. (Inherited from Component)
ContinueUpdateOnError	Gets or sets a value that specifies whether to generate an exception when an error is encountered during a row update. (Inherited from DataAdapter)
DeleteCommand	Gets or sets a Transact-SQL statement or stored procedure to delete records from the data set.
DesignMode	Gets a value that indicates whether the Component is currently in design mode. (Inherited from Component)
Events	Gets the list of event handlers that are attached to this Component. (Inherited from Component)
FillCommandBehavior	Gets or sets the behavior of the command used to fill the data adapter. (Inherited from DbDataAdapter)
FillLoadOption	Gets or sets the LoadOption that determines how the adapter fills the DataTable from the DbDataReader. (Inherited from DataAdapter)
InsertCommand	Gets or sets a Transact-SQL statement or stored procedure to insert new records into the data source.
MissingMappingAction	Determines the action to take when incoming data does not have a matching table or column. (Inherited from DataAdapter)
MissingSchemaAction	Determines the action to take when existing DataSet schema does not match incoming data. (Inherited from DataAdapter)
ReturnProviderSpecificTypes	Gets or sets whether the Fill method should return provider-specific values or common CLS-compliant values. (Inherited from DataAdapter)
SelectCommand	Gets or sets a Transact-SQL statement or stored procedure used to select records in the data source.
Site	Gets or sets the ISite of the Component. (Inherited from Component)
TableMappings	Gets a collection that provides the primary mapping between a source table and a DataTable. (Inherited from DataAdapter)
UpdateBatchSize	Gets or sets the number of rows that are processed in each round-trip to the server.
UpdateCommand	Gets or sets a Transact-SQL statement or stored procedure used to update records in the data source.

Methods

AddToBatch(IDbCommand)	Adds a IDbCommand to the current batch. (Inherited from DbDataAdapter)
ClearBatch()	Removes all IDbCommand objects from the batch. (Inherited from DbDataAdapter)
CloneInternals()	Obsolete. Creates a copy of this instance of DataAdapter. (Inherited from DataAdapter)
CreateObjRef(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)
CreateRowUpdatedEvent(DataRow, IDbCommand, StatementType, DataTableMapping)	Initializes a new instance of the RowUpdatedEventArgs class. (Inherited from DbDataAdapter)
CreateRowUpdatingEvent(DataRow, IDbCommand, StatementType, DataTableMapping)	Initializes a new instance of the RowUpdatingEventArgs class. (Inherited from DbDataAdapter)
CreateTableMappings()	Creates a new DataTableMappingCollection. (Inherited from DataAdapter)
Dispose()	Releases all resources used by the Component. (Inherited from Component)
Dispose(Boolean)	Releases the unmanaged resources used by the DbDataAdapter and optionally releases the managed resources. (Inherited from DbDataAdapter)
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
ExecuteBatch()	Executes the current batch. (Inherited from DbDataAdapter)
Fill(DataSet, Int32, Int32, String, IDbCommand, CommandBehavior)	Adds or refreshes rows in a specified range in the DataSet to match those in the data source using the DataSet and source table names, command string, and command behavior. (Inherited from DbDataAdapter)
Fill(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)
Fill(DataSet, String, IDataReader, Int32, Int32)	Adds or refreshes rows in a specified range in the DataSet to match those in the data source using the DataSet, DataTable, and IDataReader names. (Inherited from DbDataAdapter)
Fill(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)
Fill(DataSet)	Adds or refreshes rows in the DataSet. (Inherited from DbDataAdapter)
Fill(DataTable, IDataReader)	Adds or refreshes rows in a DataTable to match those in the data source using the specified DataTable and IDataReader names. (Inherited from DbDataAdapter)
Fill(DataTable, IDbCommand, CommandBehavior)	Adds or refreshes rows in a DataTable to match those in the data source using the specified DataTable, IDbCommand and CommandBehavior. (Inherited from DbDataAdapter)
Fill(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)
Fill(DataTable[], IDataReader, Int32, Int32)	Adds or refreshes rows in a specified range in the collection of DataTable objects to match those in the data source. (Inherited from DataAdapter)
Fill(DataTable[], Int32, Int32, IDbCommand, CommandBehavior)	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)
Fill(Int32, Int32, DataTable[])	Adds or refreshes rows in one or more DataTable objects 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)
FillSchema(DataSet, SchemaType, IDbCommand, String, CommandBehavior)	Adds a DataTable to the specified DataSet and configures the schema to match that in the data source based on the specified SchemaType. (Inherited from DbDataAdapter)
FillSchema(DataSet, SchemaType, String, IDataReader)	Adds a DataTable to the specified DataSet. (Inherited from DataAdapter)
FillSchema(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)
FillSchema(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)
FillSchema(DataTable, SchemaType, IDataReader)	Adds a DataTable to the specified DataSet. (Inherited from DataAdapter)
FillSchema(DataTable, SchemaType, IDbCommand, CommandBehavior)	Configures the schema of the specified DataTable based on the specified SchemaType, command string, and CommandBehavior values. (Inherited from DbDataAdapter)
FillSchema(DataTable, SchemaType)	Configures the schema of the specified DataTable based on the specified SchemaType. (Inherited from DbDataAdapter)
GetBatchedParameter(Int32, Int32)	Returns a IDataParameter from one of the commands in the current batch. (Inherited from DbDataAdapter)
GetBatchedRecordsAffected(Int32, Int32, Exception)	Returns information about an individual update attempt within a larger batched update. (Inherited from DbDataAdapter)
GetFillParameters()	Gets the parameters set by the user when executing an SQL SELECT statement. (Inherited from DbDataAdapter)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetLifetimeService()	Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject)
GetService(Type)	Returns an object that represents a service provided by the Component or by its Container. (Inherited from Component)
GetType()	Gets the Type of the current instance. (Inherited from Object)
HasTableMappings()	Indicates whether a DataTableMappingCollection has been created. (Inherited from DataAdapter)
InitializeBatching()	Initializes batching for the DbDataAdapter. (Inherited from DbDataAdapter)
InitializeLifetimeService()	Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
MemberwiseClone(Boolean)	Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject)
OnFillError(FillErrorEventArgs)	Raises the FillError event. (Inherited from DbDataAdapter)
OnRowUpdated(RowUpdatedEventArgs)	Raises the RowUpdated event of a .NET data provider. (Inherited from DbDataAdapter)
OnRowUpdating(RowUpdatingEventArgs)	Raises the RowUpdating event of a .NET data provider. (Inherited from DbDataAdapter)
ResetFillLoadOption()	Resets FillLoadOption to its default state and causes Fill(DataSet) to honor AcceptChangesDuringFill. (Inherited from DataAdapter)
ShouldSerializeAcceptChangesDuringFill()	Determines whether the AcceptChangesDuringFill property should be persisted. (Inherited from DataAdapter)
ShouldSerializeFillLoadOption()	Determines whether the FillLoadOption property should be persisted. (Inherited from DataAdapter)
ShouldSerializeTableMappings()	Determines whether one or more DataTableMapping objects exist and they should be persisted. (Inherited from DataAdapter)
TerminateBatching()	Ends batching for the DbDataAdapter. (Inherited from DbDataAdapter)
ToString()	Returns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component)
Update(DataRow[], DataTableMapping)	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 of DataRow objects. (Inherited from DbDataAdapter)
Update(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)
Update(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)
Update(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)
Update(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)

Events

Disposed	Occurs when the component is disposed by a call to the Dispose() method. (Inherited from Component)
FillError	Returned when an error occurs during a fill operation. (Inherited from DbDataAdapter)
RowUpdated	Occurs during Update(DataSet) after a command is executed against the data source. The attempt to update is made, so the event fires.
RowUpdating	Occurs during Update(DataSet) before a command is executed against the data source. The attempt to update is made, so the event fires.

Explicit Interface Implementations

ICloneable.Clone()	For a description of this member, see Clone().
IDataAdapter.TableMappings	Gets a collection that indicates how a source table is mapped to a dataset table. (Inherited from DataAdapter)
IDbDataAdapter.DeleteCommand	For a description of this member, see DeleteCommand.
IDbDataAdapter.InsertCommand	For a description of this member, see InsertCommand.
IDbDataAdapter.SelectCommand	For a description of this member, see SelectCommand.
IDbDataAdapter.UpdateCommand	For a description of this member, see UpdateCommand.

See also

• DataAdapters and DataReaders
• Manipulating Data (ADO.NET)
• ADO.NET Overview