IDataSourceWizardMongoDBConnectionStringsProvider Interface

Allows you to manage MongoDB data connections available in the Data Source Wizard and Report Wizard.

Namespace: DevExpress.DataAccess.Web

Assembly: DevExpress.DataAccess.v25.2.dll

NuGet Package: DevExpress.DataAccess

Declaration

C#

public interface IDataSourceWizardMongoDBConnectionStringsProvider :
    IDataSourceWizardConnectionStringsProvider

VB.NET

Public Interface IDataSourceWizardMongoDBConnectionStringsProvider
    Inherits IDataSourceWizardConnectionStringsProvider

Remarks

A custom connection provider allows you to manage MongoDB connections accessible to users:

• Modify connections at runtime (for example, depending on the user)
• Allow users to create new connections
• Validate connections and keep them in a separate storage
• Store credentials securely

To use a custom MongoDB connection strings provider, follow the steps below:

1. Implement the IDataSourceWizardMongoDBConnectionStringsProvider interface. The following code snippet shows a sample implementation:

   using DevExpress.DataAccess.ConnectionParameters;
   using DevExpress.DataAccess.Native;
   using DevExpress.DataAccess.Web;
   using System.Collections.Generic;
   using System.Linq;
   
   public class MyMongoDBConnectionStringsProvider : IDataSourceWizardMongoDBConnectionStringsProvider {
       public Dictionary<string, string> GetConnectionDescriptions() {
           Dictionary<string, string> connections = AppConfigHelper.GetConnections().Keys.ToDictionary(x => x, x => x);
           connections.Add("MyMongoDBConnection", "MyMongoDBConnection");
           return connections;
       }
   
       public DataConnectionParametersBase GetDataConnectionParameters(string name) {
           var mongoDBPasswordAuthInfo = new MongoDBPasswordAuthenticationInfo(
               username: "name",
               password: "password",
               authenticationDatabase: "admin"
           );
           if (name == "MyMongoDBConnection") {
               return new MongoDBConnectionParameters(
                   hostName: "localhost",
                   isSRV: true,
                   port: 27017,
                   info: mongoDBPasswordAuthInfo
               );
           }
           return AppConfigHelper.LoadConnectionParameters(name);
       }
   }
   

2. Call the RegisterDataSourceWizardMongoDBConnectionStringsProvider<T>() method at application start to register the custom connection strings provider:

   // ...
   builder.Services.ConfigureReportingServices(configurator => {
       configurator.ConfigureReportDesigner(designerConfigurator => {        
       designerConfigurator.RegisterDataSourceWizardMongoDBConnectionStringsProvider<MyDataSourceWizardConnectionStringsProvider>();
   
       });
   });
   

For additional information on MongoDB data connections in the Web Report Designer, refer to the following help topics:

• Register MongoDB Data Connections (ASP.NET Core)
• Register MongoDB Data Connections (ASP.NET MVC)
• Register MongoDB Data Connections (ASP.NET Web Forms)