DashboardExtractDataSource Class

An extract data source that is a local snapshot of data.

Namespace: DevExpress.DashboardCommon

Assembly: DevExpress.Dashboard.v18.2.Core.dll

Declaration

C#
VB.NET

public class DashboardExtractDataSource :
    IDashboardDataSource,
    IDashboardComponent,
    IComponent,
    IDisposable,
    ISupportInitialize,
    ISupportPrefix,
    IDashboardDataSourceInternal,
    IDataComponent,
    IServiceContainer,
    IServiceProvider,
    ISensitiveInfoContainer

Public Class DashboardExtractDataSource
    Implements IDashboardDataSource,
               IDashboardComponent,
               IComponent,
               IDisposable,
               ISupportInitialize,
               ISupportPrefix,
               IDashboardDataSourceInternal,
               IDataComponent,
               IServiceContainer,
               IServiceProvider,
               ISensitiveInfoContainer

Remarks

Data extracts allow you to obtain data from the existing data source (such as DashboardSqlDataSource, DashboardEFDataSource, DashboardObjectDataSource, etc.) and save this data locally. You can use this data source type as any regular data source.

Note

Note that data extracts cannot be created for the OLAP Data Source.

Data Types Supported by DashboardExtractDataSource

Note that DashboardExtractDataSource can process data fields of the following types when creating a data extract.

Example

The following code snippet shows how to create a data extract from the existing SQL data source and add it to the collection of dashboard data sources.

C#
VB.NET

using DevExpress.DashboardCommon;
using DevExpress.DataAccess.ConnectionParameters;
using DevExpress.DataAccess.Sql;
// ...
            DashboardSqlDataSource sqlDataSource = new DashboardSqlDataSource("Data Source 1", msSqlParams);
            SelectQuery selectQuery = SelectQueryFluentBuilder
                .AddTable("SalesPerson")
                .SelectColumns("CategoryName", "Extended Price")
                .Build("Query 1");
            sqlDataSource.Queries.Add(selectQuery);

            // ...

            DashboardExtractDataSource extractDataSource = new DashboardExtractDataSource();
            extractDataSource.ExtractSourceOptions.DataSource = sqlDataSource;
            extractDataSource.ExtractSourceOptions.DataMember = "Query 1";
            extractDataSource.FileName = @"C:\temp\SalesPersonExtract.dat";
            extractDataSource.UpdateExtractFile();

            dashboard.DataSources.Add(extractDataSource);

Imports DevExpress.DashboardCommon
Imports DevExpress.DataAccess.ConnectionParameters
Imports DevExpress.DataAccess.Sql
' ...
            Dim sqlDataSource As New DashboardSqlDataSource("Data Source 1", msSqlParams)
            Dim query As SelectQuery = SelectQueryFluentBuilder _ 
                .AddTable("SalesPerson") _ 
                .SelectColumns("CategoryName", "Extended Price") _
                .Build("Query 1")
            sqlDataSource.Queries.Add(selectQuery)

            ' ...

            Dim extractDataSource As New DashboardExtractDataSource()
            extractDataSource.ExtractSourceOptions.DataSource = sqlDataSource
            extractDataSource.ExtractSourceOptions.DataMember = "Query 1"
            extractDataSource.FileName = "C:\temp\SalesPersonExtract.dat"
            extractDataSource.UpdateExtractFile()

            dashboard.DataSources.Add(extractDataSource)