MongoDBConnectionParameters Class

Stores MongoDB connection parameters.

Namespace: DevExpress.DataAccess.ConnectionParameters

Assembly: DevExpress.DataAccess.v24.2.dll

Declaration

C#

public class MongoDBConnectionParameters :
    MongoDBConnectionParametersBase,
    IConnectionPageMongoDB,
    IConnectionPageHostname

VB.NET

Public Class MongoDBConnectionParameters
    Inherits MongoDBConnectionParametersBase
    Implements IConnectionPageMongoDB,
               IConnectionPageHostname

Remarks

A MongoDB data source requires a configured connection to a MongoDB instance. Create a MongoDBConnectionParameters object and assign the hostname and port of the MongoDB instance to the object’s Hostname and Port properties, respectively. Set the IsSRVRecord property to true if the hostname is an SRV record. Use the AuthenticationInfo property to specify authentication credentials. The MongoDBConnectionParameters class supports the following authentication types:

• Password Authentication
• Scram SHA256 Authentication

Assign the created parameters to the MongoDBDataSource object’s ConnectionParameters property.

Example

The example below demonstrates how to use the MongoDBDataSource class to bind an application or component to a MongoDB instance. The example uses the MongoDBConnectionParameters class to specify connection parameters to the MongoDB instance, the MongoDBPasswordAuthenticationInfo class to specify connection credentials, and the MongoDBQuery class to create data queries to the Categories and Products collections of the Northwind database.

C#

using DevExpress.DataAccess.ConnectionParameters;
using DevExpress.DataAccess.MongoDB;
// ...
var MongoDBPasswordAuthInfo = new MongoDBPasswordAuthenticationInfo(
    username: "name",
    password: "password",
    authenticationDatabase: "admin"
);

// Create a MongoDBConnectionParameters object and
// specify connection parameters to a MongoDB instance.
var connectionParameters = new MongoDBConnectionParameters(
    hostName: "localhost",
    isSRV: false,
    port: 27017,
    info: MongoDBPasswordAuthInfo
);

// Specify queries to database collections.
var queryCategories = new MongoDBQuery() {
    DatabaseName = "Northwind",
    CollectionName = "Categories",
};

var queryProducts = new MongoDBQuery() {
    DatabaseName = "Northwind",
    CollectionName = "Products",
};

// Create a MongoDBDataSource object. Assign the created connection
// parameters to the object's ConnectionParameters property. Add the
// queries to the object's Queries collection.
var mongoDBDataSource = new MongoDBDataSource() {
    ConnectionParameters = connectionParameters,
    Queries = { queryCategories, queryProducts },
};

// Call the Fill method of the MongoDBDataSource object to execute the
// queries and load data from the MongoDB instance.
mongoDBDataSource.Fill();

// Use the created object as a data source in your application or component.
// ...

VB.NET

Imports DevExpress.DataAccess.ConnectionParameters
Imports DevExpress.DataAccess.MongoDB
' ...
Dim MongoDBPasswordAuthInfo = New MongoDBPasswordAuthenticationInfo(username:="name", password:="password", authenticationDatabase:="admin")

' Create a MongoDBConnectionParameters object and
' specify connection parameters to a MongoDB instance.
Dim connectionParameters = New MongoDBConnectionParameters(hostName:="localhost", isSRV:=False, port:=27017, info:=MongoDBPasswordAuthInfo)

' Specify queries to database collections.
Dim queryCategories = New MongoDBQuery() With {
    .DatabaseName = "Northwind",
    .CollectionName = "Categories"
}

Dim queryProducts = New MongoDBQuery() With {
    .DatabaseName = "Northwind",
    .CollectionName = "Products"
}

' Create a MongoDBDataSource object. Assign the created connection
' parameters to the object's ConnectionParameters property. Add the
' queries to the object's Queries collection.
Dim mongoDBDataSource = New MongoDBDataSource() With {
    .ConnectionParameters = connectionParameters
}

mongoDBDataSource.Queries.Add(queryCategories)
mongoDBDataSource.Queries.Add(queryProducts)

' Call the Fill method of the MongoDBDataSource object to execute the
' queries and load data from the MongoDB instance.
mongoDBDataSource.Fill()

' Use the created object as a data source in your application or component.
' ...

Inheritance

Object

DataConnectionParametersBase

MongoDBConnectionParametersBase

MongoDBConnectionParameters