SqlCeDataAdapter Class
Represents a set of data commands and a database connection that are used to fill the DataSet and update the data source.
Inheritance Hierarchy
System.Object
System.MarshalByRefObject
System.ComponentModel.Component
System.Data.Common.DataAdapter
System.Data.Common.DbDataAdapter
System.Data.SqlServerCe.SqlCeDataAdapter
Namespace: System.Data.SqlServerCe
Assembly: System.Data.SqlServerCe (in System.Data.SqlServerCe.dll)
Syntax
'Declaration
Public NotInheritable Class SqlCeDataAdapter _
Inherits DbDataAdapter _
Implements ICloneable
'Usage
Dim instance As SqlCeDataAdapter
public sealed class SqlCeDataAdapter : DbDataAdapter,
ICloneable
public ref class SqlCeDataAdapter sealed : public DbDataAdapter,
ICloneable
[<SealedAttribute>]
type SqlCeDataAdapter =
class
inherit DbDataAdapter
interface ICloneable
end
public final class SqlCeDataAdapter extends DbDataAdapter implements ICloneable
The SqlCeDataAdapter type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") |
SqlCeDataAdapter() | Initializes a new instance of the SqlCeDataAdapter class. |
|
SqlCeDataAdapter(SqlCeCommand) | Initializes a new instance of the SqlCeDataAdapter class with the specified SqlCeCommand as the SelectCommand property. |
|
SqlCeDataAdapter(String, SqlCeConnection) | Initializes a new instance of the SqlCeDataAdapter class with a SelectCommand and a SqlCeConnection object. |
|
SqlCeDataAdapter(String, String) | Initializes a new instance of the SqlCeDataAdapter class with a SelectCommand and a connection string. |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
AcceptChangesDuringFill | (inherited from DataAdapter) |
|
AcceptChangesDuringUpdate | (inherited from DataAdapter) |
.gif "Protected property") |
CanRaiseEvents | (inherited from Component) |
|
Container | (inherited from Component) |
|
ContinueUpdateOnError | (inherited from DataAdapter) |
|
DeleteCommand | Gets or sets an SQL statement for deleting records from the data set. |
|
DesignMode | (inherited from Component) |
|
Events | (inherited from Component) |
|
FillCommandBehavior | (inherited from DbDataAdapter) |
|
FillLoadOption | (inherited from DataAdapter) |
|
InsertCommand | Gets or sets an SQL statement used to insert new records into the data source. |
|
MissingMappingAction | (inherited from DataAdapter) |
|
MissingSchemaAction | (inherited from DataAdapter) |
|
ReturnProviderSpecificTypes | (inherited from DataAdapter) |
|
SelectCommand | Gets or sets an SQL statement used to select records in the data source. |
|
Site | (inherited from Component) |
|
TableMappings | (inherited from DataAdapter) |
|
UpdateBatchSize | (inherited from DbDataAdapter) |
|
UpdateCommand | Gets or sets an SQL statement used to update records in the data source. |
Top
Methods
.gif "Protected method")
Top
Events
| Name | Description | |
|---|---|---|
.gif "Public event") |
Disposed | (inherited from Component) |
|
FillError | (inherited from DataAdapter) |
|
RowUpdated | Occurs during a call to Update after an update command is executed against the data source. The attempt to update is made and then this event fires. |
|
RowUpdating | Occurs during a call to Update before an update command is executed against the data source. The attempt to update is made, and then this event fires. |
Top
Explicit Interface Implementations
| Name | Description | |
|---|---|---|
.gif "Explicit interface implemetation") .gif "Private method") |
ICloneable.Clone | For a description of this member, see ICloneable.Clone(). |
.gif "Private property") |
IDbDataAdapter.DeleteCommand | (inherited from DbDataAdapter) |
|
IDbDataAdapter.InsertCommand | (inherited from DbDataAdapter) |
|
IDbDataAdapter.SelectCommand | (inherited from DbDataAdapter) |
|
IDataAdapter.TableMappings | (inherited from DataAdapter) |
|
IDbDataAdapter.UpdateCommand | (inherited from DbDataAdapter) |
Top
Remarks
The SqlCeDataAdapter serves as a bridge between a DataSet and data source. It is used for retrieving data from, and saving data to, the data source. The SqlCeDataAdapter 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 SqlCeDataAdapter fills a DataSet, it creates the necessary tables and columns for the returned data if they do not already exist. However, primary key information will not be included in the implicitly created schema unless the MissingSchemaAction property is set to AddWithKey. You can also have the SqlCeDataAdapter create the schema of the DataSet, including primary key information, before filling it with data by using FillSchema.
The SqlCeDataAdapter includes the SelectCommand, InsertCommand, DeleteCommand, UpdateCommand, and TableMappings properties to facilitate the loading and updating of data.
When you create an instance of SqlCeDataAdapter, properties are set to their initial values. For a list of these values, see the SqlCeDataAdapter constructor.
Examples
The following example uses the SqlCeCommand, SqlCeDataAdapter, and SqlCeConnection to select records from a data source and populate a DataSet with the selected rows. The populated DataSet is then returned. To accomplish this, the method is passed an initialized DataSet, a connection string, and a query string that is an SQL SELECT statement.
Try
Dim strDataSource As String
strDataSource = "" & _
"Data Source = C:\Program Files\" & _
"Microsoft SQL Server Compact Edition\v3.5\Samples\" & _
"Northwind.sdf"
Dim conn As New SqlCeConnection
conn.ConnectionString = strDataSource & ";Password='<password>'"
Dim selectCmd As SqlCeCommand = conn.CreateCommand
selectCmd.CommandText = "SELECT * FROM Employees"
Dim adp As New SqlCeDataAdapter(selectCmd)
Dim ds As New DataSet
' Note: Fill will leave the connection in its original state;
' In this case, the connection was closed so it will be left closed
adp.Fill(ds)
Console.WriteLine(("The SqlCeDataAdapter succesfully filled " & _
ds.Tables.Item(0).Rows.Count & " rows in the DataSet!"))
Catch ds As Exception
Console.WriteLine(ds.Message)
Finally
Console.WriteLine(vbNewLine & vbNewLine & vbNewLine & _
"Press any key to continue...")
Console.ReadKey()
End Try
try
{
string strDataSource =
@"Data Source = C:\Program Files\" +
@"Microsoft SQL Server Compact Edition\v3.5\Samples\" +
@"Northwind.sdf";
SqlCeConnection conn = new SqlCeConnection();
conn.ConnectionString = strDataSource + ";Password='<password>'";
SqlCeCommand selectCmd = conn.CreateCommand();
selectCmd.CommandText = "SELECT * FROM Employees";
SqlCeDataAdapter adp = new SqlCeDataAdapter(selectCmd);
DataSet ds = new DataSet();
// Note: Fill will leave the connection in its original state;
// In this case, the connection was closed so it will be left closed
//
adp.Fill(ds);
Console.WriteLine("The SqlCeDataAdapter succesfully filled " +
ds.Tables[0].Rows.Count + " rows in the DataSet!");
}
catch (Exception ex)
{
Console.WriteLine(ex.Message);
}
finally
{
Console.WriteLine("\n\n\nPress any key to continue...");
Console.ReadKey();
}
Thread Safety
Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.