Microsoft KB Archive/301248

= How to update a database from a DataSet object by using Visual Basic .NET =

Article ID: 301248

Article Last Modified on 3/29/2007

-

APPLIES TO


 * Microsoft Visual Basic .NET 2002 Standard Edition
 * Microsoft Visual Basic .NET 2003 Standard Edition

-



This article was previously published under Q301248







For a Microsoft Visual C# .NET version of this article, see 307587.



For a Microsoft Visual C++ .NET version of this article, see 815660.



For a Microsoft Visual Basic 6.0 version of this article, see 190727.

IN THIS TASK
SUMMARY
 * Requirements
 * How to update a database from a DataSet object
 * Complete code listing

REFERENCES



SUMMARY
DataSet objects, a key part of data access in the Microsoft .NET Framework, are in-memory objects that can hold tables, views, and relationships. This article demonstrates how to take a DataSet that contains data (which is loaded from a database), modify that data, and then send it back to the database to update the original source.

back to the top

Requirements
The following list outlines the recommended hardware, software, network infrastructure, and service packs that you need:
 * Microsoft Windows 2000 Professional, Windows 2000 Server, Windows 2000 Advanced Server, or Windows NT 4.0 Server
 * Microsoft SQL Server version 7.0 or 2000 or Microsoft Data Engine (MSDE) with the PUBS sample database installed
 * Microsoft Visual Studio .NET
 * The appropriate permissions and the correct values for connecting to your computer that is running SQL Server

This article assumes that you are familiar with the following topics:
 * Database terminology
 * Structured Query Language (SQL)

back to the top

How to update a database from a DataSet object
This section demonstrates how to use the DataSet object to update data in a database. It is important to remember that you can also use a SqlCommand object to insert, update, and delete data in a database directly.

To help you understand this article, click the article number below to view the article in the Microsoft Knowledge Base:

301216 How to populate a DataSet object from a database by using Visual Basic .NET

Some of the topics that are covered in 301216 include how to retrieve data from a database and into a DataSet, and how the DataSet is separate and distinct from the database.

After the DataSet is loaded, you can modify the data, and the DataSet will track the changes. The DataSet object can be considered an in-memory cache of data that is retrieved from a database and consists of a collection of tables, relationships, and constraints.

To update a DataSet and send those updates back to the database, follow these steps:  Open Microsoft Visual Studio .NET. Create a new Console Application in Visual Basic .NET. By default, Visual Studio creates a Static Module and an empty Main procedure.  Make sure that the project contains a reference to the System and System.Data namespaces. Use the Imports statement on the System, SystemData, and System.Data.SqlClient namespaces so that you are not required to qualify declarations from these namespaces later in your code. You must use these statements prior to any other declarations. Imports System Imports System.Data Imports System.Data.SqlClient   Before you can modify the data and submit the changes back to the database, you must load the information into the DataSet. For the detailed procedure, refer to 301216. To avoid duplication, the code in this step is not presented in detail.

The connection string in the following code points to a SQL Server that is located on the local computer (or the computer where the code is running). Replace this string with your own settings, if required. To summarize, a connection is created, and then a data adapter is created, which is used to fill the DataSet with data.

Note In the sample code that appears in this article, you must change UID=  and Password=  to the correct values. Make sure that the user ID has the appropriate permissions to perform this operation on the database. Dim sConnectionString As String

' Modify the following code to correctly connect to your SQL Server. sConnectionString = &quot;Password=StrongPassword;User ID=UserName;&quot; & _ &quot;Initial Catalog=pubs;&quot; & _ &quot;Data Source=(local)&quot;

Dim objConn As New SqlConnection(sConnectionString) objConn.Open

' Create an instance of a DataAdapter. Dim daAuthors As _ New SqlDataAdapter(&quot;Select * From Authors&quot;, objConn)

' Create an instance of a DataSet, and retrieve data from the Authors table. Dim dsPubs As New DataSet(&quot;Pubs&quot;) daAuthors.FillSchema(dsPubs, SchemaType.Source, &quot;Authors&quot;) daAuthors.Fill(dsPubs, &quot;Authors&quot;)  Now that the data is loaded, you can modify it. There are many ways to add a row (or record). This code sample uses a three step procedure: <ul> Obtain a new DataRow object from the DataTable.</li> Set the DataRow field values as necessary.</li> Pass that new object into the Add method of the DataTable.Rows collection.</li></ul> </li></ol>

Paste the following code after the code in step 4: '***************** 'BEGIN ADD CODE ' Create a new instance of a DataTable. Dim tblAuthors As DataTable tblAuthors = dsPubs.Tables(&quot;Authors&quot;)

Dim drCurrent As DataRow ' Obtain a new DataRow object from the DataTable. drCurrent = tblAuthors.NewRow

' Set the DataRow field values as necessary. drCurrent(&quot;au_id&quot;) = &quot;993-21-3427&quot; drCurrent(&quot;au_fname&quot;) = &quot;George&quot; drCurrent(&quot;au_lname&quot;) = &quot;Johnson&quot; drCurrent(&quot;phone&quot;) = &quot;800 226-0752&quot; drCurrent(&quot;address&quot;) = &quot;1956 Arlington Pl.&quot; drCurrent(&quot;city&quot;) = &quot;Winnipeg&quot; drCurrent(&quot;state&quot;) = &quot;MB&quot; drCurrent(&quot;contract&quot;) = 1

'Pass that new object into the Add method of the DataTable.Rows collection. tblAuthors.Rows.Add(drCurrent) MsgBox(&quot;Add was successful.&quot;)

'END ADD CODE To edit existing rows, obtain the appropriate DataRow object, and then provide new values for one or more columns. You must first find the correct row, which is much easier because you loaded the schema of the table as well as the data (the call to FillSchema in step 4). With the schema in place, the table knows which column is its primary key, and the Find method of the Rows collection is available.

The Find method returns the DataRow object with a specific value in its primary key (in this case, au_id). After you have that DataRow, you can modify the columns. You do not have to wrap the modifications in BeginEdit and EndEdit, but this simplifies the work that the DataSet has to do and allows the DataSet to perform its validation checks all at once upon the EndEdit call. Paste the following code after the ADD code: '***************** 'BEGIN EDIT CODE

drCurrent = tblAuthors.Rows.Find(&quot;213-46-8915&quot;) drCurrent.BeginEdit drCurrent(&quot;phone&quot;) = &quot;342&quot; & drCurrent(&quot;phone&quot;).ToString.Substring(3) drCurrent.EndEdit MsgBox(&quot;Record edited successfully&quot;)

'END EDIT CODE To update the original database with all of these changes, pass the DataSet into the Update method of the DataAdapter object.

However, before you can call Update, you must set the InsertCommand, UpdateCommand, and DeleteCommand properties of the DataAdapter object. You can manually write SQL and populate these three properties with corresponding SqlCommand objects, but you can also use Visual Studio .NET to generate these three commands automatically.

To generate the required commands when they are needed, you must create an instance of the SqlCommandBuilder object and use the DataAdapter in the constructor. If you want to use this method, which is illustrated in the code sample to follow, you must have primary key information available for your table. To access primary key information, call FillSchema, and then set the MissingSchemaAction property of your DataAdapter to AddWithKey, or manually set the primary key in your code. Paste the following code after the EDIT code: '***************** 'BEGIN SEND CHANGES TO SQL SERVER

Dim objCommandBuilder As New SqlCommandBuilder(daAuthors) daAuthors.Update(dsPubs, &quot;Authors&quot;) MsgBox(&quot;SQL Server updated successfully&quot; & chr(13) & &quot;Check Server explorer to see changes&quot;)

' END SEND CHANGES TO SQL SERVER To delete a row completely, use the Delete method of the DataRow object. Note that the Rows collection contains two methods, Remove and RemoveAt, which seem to delete the row but instead just remove the row from the collection. Only the Delete method sends your deletion back to the source database. Paste the following code after the SEND CHANGES TO SQL SERVER code: '***************** 'BEGIN DELETE CODE

drCurrent = tblAuthors.Rows.Find(&quot;993-21-3427&quot;) drCurrent.Delete MsgBox(&quot;Record deleted successfully&quot;)

'END DELETE CODE Send the changes to SQL Server to remove the record that you added earlier. Paste the following code after the DELETE code: '***************** ' CLEAN UP SQL SERVER daAuthors.Update(dsPubs, &quot;Authors&quot;) MsgBox(&quot;SQL Server updated successfully&quot; & Chr(13) & Chr(13) & &quot;Check Server Explorer to see changes&quot;) Save your project. On the Debug menu, click Start to run the project. Notice that several message boxes appear, which indicate the progress of the code and allow you to review the current state of the data as the code progresses. back to the top

Complete code listing
Imports System Imports System.Data Imports System.Data.SqlClient

Module Module1

Sub Main Dim sConnectionString As String ' Modify the following code to correctly connect to your SQL Server. sConnectionString = &quot;Password=StrongPassword;User ID=UserName;&quot; & _ &quot;Initial Catalog=pubs;&quot; & _ &quot;Data Source=(local)&quot;

Dim objConn As New SqlConnection(sConnectionString) objConn.Open

' Create an instance of a DataAdapter. Dim daAuthors As _ New SqlDataAdapter(&quot;Select * From Authors&quot;, objConn)

' Create an instance of a DataSet, and retrieve data from the Authors table. Dim dsPubs As New DataSet(&quot;Pubs&quot;) daAuthors.FillSchema(dsPubs, SchemaType.Source, &quot;Authors&quot;) daAuthors.Fill(dsPubs, &quot;Authors&quot;)

'*****************       'BEGIN ADD CODE ' Create a new instance of a DataTable Dim tblAuthors As DataTable tblAuthors = dsPubs.Tables(&quot;Authors&quot;)

Dim drCurrent As DataRow ' Obtain a new DataRow object from the DataTable. drCurrent = tblAuthors.NewRow

' Set the DataRow field values as necessary. drCurrent(&quot;au_id&quot;) = &quot;993-21-3427&quot; drCurrent(&quot;au_fname&quot;) = &quot;George&quot; drCurrent(&quot;au_lname&quot;) = &quot;Johnson&quot; drCurrent(&quot;phone&quot;) = &quot;800 226-0752&quot; drCurrent(&quot;address&quot;) = &quot;1956 Arlington Pl.&quot; drCurrent(&quot;city&quot;) = &quot;Winnipeg&quot; drCurrent(&quot;state&quot;) = &quot;MB&quot; drCurrent(&quot;contract&quot;) = 1

'Pass that new object into the Add method of the DataTable.Rows collection. tblAuthors.Rows.Add(drCurrent) MsgBox(&quot;Add was successful.&quot;)

'END ADD CODE '*****************       'BEGIN EDIT CODE

drCurrent = tblAuthors.Rows.Find(&quot;213-46-8915&quot;) drCurrent.BeginEdit drCurrent(&quot;phone&quot;) = &quot;342&quot; & drCurrent(&quot;phone&quot;).ToString.Substring(3) drCurrent.EndEdit MsgBox(&quot;Record edited successfully&quot;)

'END EDIT CODE '*****************       'BEGIN SEND CHANGES TO SQL SERVER

Dim objCommandBuilder As New SqlCommandBuilder(daAuthors) daAuthors.Update(dsPubs, &quot;Authors&quot;) MsgBox(&quot;SQL Server updated successfully&quot; & chr(13) & &quot;Check Server explorer to see changes&quot;)

' END SEND CHANGES TO SQL SERVER '*****************       'BEGIN DELETE CODE

drCurrent = tblAuthors.Rows.Find(&quot;993-21-3427&quot;) drCurrent.Delete MsgBox(&quot;Record deleted successfully&quot;)

'END DELETE CODE '*****************       ' CLEAN UP SQL SERVER daAuthors.Update(dsPubs, &quot;Authors&quot;) MsgBox(&quot;SQL Server updated successfully&quot; & Chr(13) & Chr(13) & &quot;Check Server Explorer to see changes&quot;) End Sub

End Module back to the top

<div class="references_section">