dotConnect for MongoDB provides design-time integration with Visual Studio 2017, 2019, 2022, and 2026 through Data Designer Extensibility (DDEX). This integration lets you manage MongoDB connections in Server Explorer and use Visual Studio's built-in data design tools, including DataSet Designer, Data Source Configuration Wizard, TableAdapter Configuration Wizard, and data preview features. You can also configure the SqlDataSource control in ASP.NET applications.

This article explains the available integration features and how to use them.

Integrating with Server Explorer

Server Explorer is a Visual Studio window for managing server connections and exploring database objects. With dotConnect for MongoDB, you can create connections to MongoDB servers and browse their databases.

Server Explorer displays collections from the database specified in the connection as tables. Expand a collection to view its columns. To view the collection data, right-click the collection and select Show Table Data.

Connections created in Server Explorer are also available to other Visual Studio data design tools.

To open Server Explorer, select View > Server Explorer.

Add/Modify Connection dialog

The Add/Modify Connection dialog lets you create new MongoDB connections and modify existing ones.

You can open the dialog in one of the following ways:

• Select Tools > Connect to Database.
• In Server Explorer, right-click Data Connections and select Add Connection.
• In Server Explorer, right-click an existing connection and select Modify Connection.

The following table describes the connection settings available in the dialog.

After you specify the connection settings, click Test Connection to verify the connection, then click OK.

Advanced Properties dialog

The Advanced Properties dialog provides access to all dotConnect for MongoDB connection properties, including advanced settings that are not available in the Add/Modify Connection dialog. Use this dialog to configure additional connection parameters when necessary. To open the dialog, click Advanced in the Add/Modify Connection dialog.

Design-time integration with project data

Data Source Configuration Wizard

Data Source Configuration Wizard lets you create and configure data sources for your application. Data sources can be based on databases, web services, or objects and can be bound to controls that display data on forms.

For Windows Forms applications, the wizard can generate a DataSet and add it to your project. The generated DataSet appears in the Data Sources window, where you can drag its elements onto forms to create data-bound controls. You can further customize the DataSet using DataSet Designer and TableAdapter Configuration Wizard.

You can open Data Source Configuration Wizard in one of the following ways:

• Select Project > Add New Data Source.
• In the Data Sources window, select Add New Data Source.
• Select Add New Data Source from the DataSource property of a data-bindable Windows Forms control.

To create a data source:

1. Open Data Source Configuration Wizard.
2. Select Database as the data source type and click Next.
3. Select Dataset and click Next.
4. Click New Connection, change the data source to MongoDB Database with the dotConnect for MongoDB data provider, enter the connection details, and click OK.
5. Choose whether to save sensitive connection information in the application configuration file.
6. Select the database objects to include in the DataSet and complete the wizard.

After completing the wizard, you can view and modify the generated DataSet in Solution Explorer.

TableAdapter Configuration Wizard

TableAdapter Configuration Wizard lets you create and configure TableAdapters based on SQL statements.

A TableAdapter connects to a database, executes queries, and populates a DataTable with the returned data. It can fill an existing DataTable or create and return a new one.

To open TableAdapter Configuration Wizard, open the DataSet in DataSet Designer, right-click the TableAdapter, and select Configure.

You can use the wizard to define queries and configure how data is retrieved from MongoDB collections.

Using parameterized TableAdapter queries

Parameterized queries let you retrieve data that matches specific conditions without hardcoding values into SQL statements.

For example, to retrieve customers from a particular city, add a WHERE clause with a parameter to your query.

SELECT * FROM customers WHERE city = :city

The :city parameter lets you specify the city when executing the query.

To create a parameterized TableAdapter query, open the DataSet in DataSet Designer, right-click the TableAdapter, and select Add Query. In the wizard, enter a SELECT statement with a parameter in the WHERE clause.

Web SQL Data Source Wizard

Web SQL Data Source Wizard lets you configure data sources for ASP.NET web controls. It provides functionality similar to Data Source Configuration Wizard.

To configure a data source for an ASP.NET web control:

1. In Visual Studio, create or open an .aspx page and switch to Design view.
2. From the Toolbox, drag a data-bound server control, such as GridView, onto the page.
3. Right-click the control and select Show Smart Tag.
4. In the control's tasks panel, open the Choose Data Source list and select New data source. If the list is not displayed, click Choose Data Source to open it.