Skip to main content

Adding a MySQL Data Source

breaking changes

Currently, the Reveal SDK is in the process of decoupling the data sources from the Reveal SDK core package. In order to ensure the project's continued functionality, you might be required to install additional packages into your project. Please see the Supported Data Sources topic for more information.

On the Client

Step 1 - Add an event handler for the RevealView.onDataSourcesRequested event.

var revealView = new $.ig.RevealView("#revealView");
revealView.onDataSourcesRequested = (callback) => {
//add code here
callback(new $.ig.RevealDataSources([], [], false));
};

Step 2 - In the RevealView.onDataSourcesRequested event handler, create a new instance of the RVMySqlDataSource object. Set the Host, Database, Port, and Title properties to values that correspond to your MySQL server. After you have created the RVMySqlDataSource object, add it to the data sources collection.

revealView.onDataSourcesRequested = (callback) => {
var mySqlDataSource = new $.ig.RVMySqlDataSource();
mySqlDataSource.host = "your-db-host";
mySqlDataSource.database = "your-db-name";
mySqlDataSource.port = 1234;
mySqlDataSource.title = "My MySQL";

callback(new $.ig.RevealDataSources([mySqlDataSource], [], false));
};

When the application runs, create a new Visualization and you will see the newly created MySQL data source listed in the "Select a Data Source" dialog.

Step 3 - Add a new Data Source Item by creating a new instance of the RVMySqlDataSourceItem object. Set the Id,Title, and Table properties that correspond to your database table. After you have created the RVMySqlDataSourceItem object, add it to the data source items collection.

revealView.onDataSourcesRequested = (callback) => {
var mySqlDataSource = new $.ig.RVMySqlDataSource();
mySqlDataSource.host = "your-db-host";
mySqlDataSource.database = "your-db-name";
mySqlDataSource.port = 1234;
mySqlDataSource.title = "My MySQL";

var mySqlDsi = new $.ig.RVMySqlDataSourceItem(mySqlDataSource);
mySqlDsi.id = "MyMySqlDataSourceItem";
mySqlDsi.title = "My MySQL Item";
mySqlDsi.table = "TableName";

callback(new $.ig.RevealDataSources([mySqlDataSource], [mySqlDsi], false));
};

When the application runs, create a new Visualization and you will see the newly created MySQL data source item listed in the "Select a Data Source" dialog.

On the Server

Step 1 - Create the data source and data source item on the client, but do not provide any connection information. Only provie an id, title, and/or subtitle.

var revealView = new $.ig.RevealView("#revealView");
revealView.onDataSourcesRequested = (callback) => {

var mySqlDataSource = new $.ig.RVMySqlDataSource();
mySqlDataSource.id = "MyMySqlDataSource";
mySqlDataSource.title = "My MySQL";

var mySqlDataSourceItem = new $.ig.RVMySqlDataSourceItem(mySqlDataSource);
mySqlDataSourceItem.id = "MyMySqlDataSourceItem";
mySqlDataSourceItem.title = "My MySQL Item";

callback(new $.ig.RevealDataSources([mySqlDataSource], [mySqlDataSourceItem], true));
};

Step 2 - Create the data source provider. In this example, we are providing connection information to connect to our MySQL database that was defined on the client. To achieve this, we determine the type of the data source/item we are working with, and set the available properties on the object.

public class DataSourceProvider : IRVDataSourceProvider
{
public Task<RVDataSourceItem> ChangeDataSourceItemAsync(IRVUserContext userContext, string dashboardId,
RVDataSourceItem dataSourceItem)
{
if (dataSourceItem is RVMySqlDataSourceItem mySqlDataSourceItem)
{
//update underlying data source
ChangeDataSourceAsync(userContext, mySqlDataSourceItem.DataSource);

//only change the table if we have selected our custom data source item
if (mySqlDataSourceItem.Id == "MyMySqlDataSourceItem")
{
mySqlDataSourceItem.Table = "orders";
}
}

return Task.FromResult(dataSourceItem);
}

public Task<RVDashboardDataSource> ChangeDataSourceAsync(IRVUserContext userContext,
RVDashboardDataSource dataSource)
{
if (dataSource is RVMySqlDataSource mySqlDataSource)
{
mySqlDataSource.Host = "localhost";
mySqlDataSource.Database = "database";
}

return Task.FromResult(dataSource);
}
}
Get the Code

The source code to this sample can be found on GitHub