How to: Manage Local Data Files in Your Project

A local database file can be included as a file in a project. The first time you connect your application to a local database file, you can choose between creating a copy of the database in your project or connecting to the existing database file in its current location. If you choose to connect to the existing file, then a connection is created just as if you were connecting to any remote database, and the database file is left in its original location. If you choose to copy the database into your project, Visual Studio creates a copy of the database file, adds it to your project, and modifies the connection so that it now points to the database in your project as opposed to the original location of the database file.

Note

Existing data connections in Server Explorer/Database Explorer are modified to point to the database file in the project as well (the database file in the project's root folder).

When you build a project, the database file might be copied from the root project folder into the output (bin) folder. (Select Show All Files in Solution Explorer to view the bin folder.) This behavior is based on the setting of the Copy to Output Directory property of the file. The default setting of the property depends on the type of database file you are using.

Note

The behavior of the Copy to Output Directory property does not apply to Web or C++ projects.

During application development, any changes made to the data (during run time within your application) are made to the database in the bin folder. For example, when you press F5 to debug your application, you are connected to the database in the bin folder. The database file in your root project folder is changed only when you edit the database schema or data by using Server Explorer, Database Explorer or other Visual Database Tools.

The following table describes the settings of the Copy to Output Directory property.

Setting

Behavior

Copy if newer (default for .sdf files)

The database file is copied from the project directory to the bin directory the first time the project is built. Every subsequent time you build the project, the Date Modified property of the files is compared. If the file in the project folder is newer, it is copied to the bin folder, replacing the file that is currently there. If the file in the bin folder is newer, no files are copied. This setting persists any changes made to the data during run time, meaning that every time you run your application and save changes to the data, those changes are visible the next time you run your application.

Warning

We don’t recommend this option for .mdb or .mdf files. The database file can change even when no changes are made to the data. Simply opening a connection on a data file (for example, by expanding the Tables node in Server Explorer) can mark it as newer.

Copy always (default for .mdf and .mdb files)

The database file is copied from the project directory to the /bin directory every time you build your application. Therefore, if you build your application and save changes to the file in the /bin directory, those changes are overwritten the next time that the original file is copied to the /bin directory.

Do not copy

The file is never copied or overwritten by the project system. You must manually copy the file from the project directory to the output directory if you use this setting.

Procedure

To respond to the Local database file dialog box

  • Click Yes if you want Visual Studio to copy the database file into your project and modify the connection to point to the copy in your project. For more information on working with database files in your project, see Local Data Overview.

  • Click No if you do not want Visual Studio to copy the database file into your project. Instead, the connection points to the file in the original location and the database file is not added as a file to the project.

See Also

Tasks

Walkthrough: Connecting to Data in a SQL Server Express LocalDB Database (Windows Forms)

Walkthrough: Connecting to Data in an Access Database (Windows Forms)

Walkthrough: Creating a SQL Server Compact Database

Other Resources

Using SQL Server Compact (Visual Studio)