SqlDataAdapter Class

 

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.

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

System.Object
  System.MarshalByRefObject
    System.ComponentModel.Component
      System.Data.Common.DataAdapter
        System.Data.Common.DbDataAdapter
          System.Data.SqlClient.SqlDataAdapter

public sealed class SqlDataAdapter : DbDataAdapter, IDbDataAdapter, 
	IDataAdapter, ICloneable

NameDescription
System_CAPS_pubmethodSqlDataAdapter()

Initializes a new instance of the SqlDataAdapter class.

System_CAPS_pubmethodSqlDataAdapter(SqlCommand)

Initializes a new instance of the SqlDataAdapter class with the specified SqlCommand as the SelectCommand property.

System_CAPS_pubmethodSqlDataAdapter(String, SqlConnection)

Initializes a new instance of the SqlDataAdapter class with a SelectCommand and a SqlConnection object.

System_CAPS_pubmethodSqlDataAdapter(String, String)

Initializes a new instance of the SqlDataAdapter class with a SelectCommand and a connection string.

NameDescription
System_CAPS_pubpropertyAcceptChangesDuringFill

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.)

System_CAPS_pubpropertyAcceptChangesDuringUpdate

Gets or sets whether AcceptChanges is called during a Update.(Inherited from DataAdapter.)

System_CAPS_pubpropertyContainer

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

System_CAPS_pubpropertyContinueUpdateOnError

Gets or sets a value that specifies whether to generate an exception when an error is encountered during a row update.(Inherited from DataAdapter.)

System_CAPS_pubpropertyDeleteCommand

Gets or sets a Transact-SQL statement or stored procedure to delete records from the data set.

System_CAPS_protpropertyFillCommandBehavior

Gets or sets the behavior of the command used to fill the data adapter.(Inherited from DbDataAdapter.)

System_CAPS_pubpropertyFillLoadOption

Gets or sets the LoadOption that determines how the adapter fills the DataTable from the DbDataReader.(Inherited from DataAdapter.)

System_CAPS_pubpropertyInsertCommand

Gets or sets a Transact-SQL statement or stored procedure to insert new records into the data source.

System_CAPS_pubpropertyMissingMappingAction

Determines the action to take when incoming data does not have a matching table or column.(Inherited from DataAdapter.)

System_CAPS_pubpropertyMissingSchemaAction

Determines the action to take when existing DataSet schema does not match incoming data.(Inherited from DataAdapter.)

System_CAPS_pubpropertyReturnProviderSpecificTypes

Gets or sets whether the Fill method should return provider-specific values or common CLS-compliant values.(Inherited from DataAdapter.)

System_CAPS_pubpropertySelectCommand

Gets or sets a Transact-SQL statement or stored procedure used to select records in the data source.

System_CAPS_pubpropertySite

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

System_CAPS_pubpropertyTableMappings

Gets a collection that provides the master mapping between a source table and a DataTable.(Inherited from DataAdapter.)

System_CAPS_pubpropertyUpdateBatchSize

Gets or sets the number of rows that are processed in each round-trip to the server.(Overrides DbDataAdapter.UpdateBatchSize.)

System_CAPS_pubpropertyUpdateCommand

Gets or sets a Transact-SQL statement or stored procedure used to update records in the data source.

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_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_pubmethodFill(DataSet)

Adds or refreshes rows in the DataSet.(Inherited from DbDataAdapter.)

System_CAPS_pubmethodFill(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.)

System_CAPS_pubmethodFill(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.)

System_CAPS_pubmethodFill(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.)

System_CAPS_pubmethodFill(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.)

System_CAPS_pubmethodFillSchema(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.)

System_CAPS_pubmethodFillSchema(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.)

System_CAPS_pubmethodFillSchema(DataTable, SchemaType)

Configures the schema of the specified DataTable based on the specified SchemaType.(Inherited from DbDataAdapter.)

System_CAPS_pubmethodGetFillParameters()

Gets the parameters set by the user when executing an SQL SELECT statement.(Inherited from DbDataAdapter.)

System_CAPS_pubmethodGetHashCode()

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

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_pubmethodInitializeLifetimeService()

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

System_CAPS_pubmethodResetFillLoadOption()

Resets FillLoadOption to its default state and causes DataAdapter.Fill to honor AcceptChangesDuringFill.(Inherited from DataAdapter.)

System_CAPS_pubmethodShouldSerializeAcceptChangesDuringFill()

Determines whether the AcceptChangesDuringFill property should be persisted.(Inherited from DataAdapter.)

System_CAPS_pubmethodShouldSerializeFillLoadOption()

Determines whether the FillLoadOption property should be persisted.(Inherited from DataAdapter.)

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_pubmethodUpdate(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.)

System_CAPS_pubmethodUpdate(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.)

System_CAPS_pubmethodUpdate(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.)

System_CAPS_pubmethodUpdate(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.)

NameDescription
System_CAPS_pubeventDisposed

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

System_CAPS_pubeventFillError

Returned when an error occurs during a fill operation.(Inherited from DataAdapter.)

System_CAPS_pubeventRowUpdated

Occurs during Update after a command is executed against the data source. The attempt to update is made, so the event fires.

System_CAPS_pubeventRowUpdating

Occurs during Update before a command is executed against the data source. The attempt to update is made, so the event fires.

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodICloneable.Clone()

For a description of this member, see Clone.

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIDataAdapter.TableMappings

Indicates how a source table is mapped to a dataset table.(Inherited from DataAdapter.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIDbDataAdapter.DeleteCommand

For a description of this member, see DeleteCommand.

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIDbDataAdapter.InsertCommand

For a description of this member, see InsertCommand.

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIDbDataAdapter.SelectCommand

For a description of this member, see SelectCommand.

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIDbDataAdapter.UpdateCommand

For a description of this member, see UpdateCommand.

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.

System_CAPS_noteNote

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.

System_CAPS_noteNote

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 Creating and Using User-Defined Types in SQL Server Books Online.

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;
    }
}

.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: