DashboardConfigurator.SetDBSchemaProvider(IDBSchemaProviderEx) Method

Specifies a database schema provider for the Web Dashboard.

Namespace: DevExpress.DashboardWeb

Assembly: DevExpress.Dashboard.v24.1.Web.dll

NuGet Package: DevExpress.Web.Dashboard.Common

Declaration

C#

public void SetDBSchemaProvider(
    IDBSchemaProviderEx provider
)

VB.NET

Public Sub SetDBSchemaProvider(
    provider As IDBSchemaProviderEx
)

Parameters

Name	Type	Description
provider	IDBSchemaProviderEx	A database schema provider that implements the IDBSchemaProviderEx interface.

Remarks

Tip

For information on how to use the DashboardConfigurator‘s API, see the following topic: Server-Side API Overview.

To use a custom database schema provider for SQL data sources, implement the IDBSchemaProviderEx interface. Pass an instance of the created class to the DashboardConfigurator.SetDBSchemaProvider method to assign the provider to the Web Dashboard:

// The configurator variable is an instance of the DashboardConfiguartor class.
configurator.SetDBSchemaProvider(new CustomDBSchemaProvider());

For more information on custom database schema providers, refer to the following article: Implement a Custom Database Schema in ASP.NET MVC and ASP.NET Core.

The following examples show how to implement a custom database schema provider:

View Example: ASP.NET Core View Example: ASP.NET MVC

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the SetDBSchemaProvider(IDBSchemaProviderEx) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

mvc-dashboard-customize-data-store-schema-for-sql-data-sources/CS/MvcDashboard_CustomSchemaProvider/App_Start/DashboardConfig.cs#L18

// Uncomment one of the following lines depending on the provider.
DashboardConfigurator.Default.SetDBSchemaProvider(new ManualDBSchemaProvider());
// DashboardConfigurator.Default.SetDBSchemaProvider(new LimitDBSchemaProvider());

DashboardUserBasedMVC/CS/MVCDashboard/App_Start/DashboardConfig.cs#L14

DashboardConfigurator.Default.SetDashboardStorage(new CustomDashboardStorage("~/App_Data/Dashboards/"));
DashboardConfigurator.Default.SetDBSchemaProvider(new CustomDBSchemaProvider());

VB.NET

mvc-dashboard-customize-data-store-schema-for-sql-data-sources/VB/MvcDashboard_CustomSchemaProvider/App_Start/DashboardConfig.vb#L25

' Uncomment one of the following lines depending on the provider.
DashboardConfigurator.Default.SetDBSchemaProvider(New LimitDBSchemaProvider())
' DashboardConfigurator.Default.SetDBSchemaProvider(New ManualDBSchemaProvider())