Edit

Use local database files in Office solutions overview

  • Article

You can include a database file, such as a SQL Server Express (.mdf) file or a Microsoft Office Access (.mdb) file, in your Office solution. This enables end users to maintain a local database in situations where maintaining a centralized database is not required, for example in a local inventory solution that is used on only a single computer.

Applies to: The information in this topic applies to document-level projects and VSTO Add-in projects. See Features available by Office application and project type.

Import the database file into a project

To import the database file into your project, use the Data Source Configuration Wizard to create a data source based on the database file. The wizard adds the database file and a typed dataset to your project.

Deploy the database file

The Data Source Configuration Wizard uses a relative path to create connections to the local database file. This enables you to copy the solution from one computer to another if you maintain the relative positions of the files.

If you deploy your solution to a server and then distribute the document to each end user, you must also manually distribute the database file and install it in the same position relative to the document. This means that the end user cannot move the document to a new location on his or her computer, unless he or she also moves the database file.

Local database files and caching the dataset

In document-level solutions for Microsoft Office Excel and Microsoft Office Word, you can cache datasets in the document by marking the dataset instance with the attribute CachedAttribute. When you add the database file to your project by using the Data Source Configuration Wizard, a typed dataset is added to your project automatically. It is rarely necessary to apply CachedAttribute to this dataset, because the data is already local on the user's computer. For more information, see Cache data.

Related content