Connecting Bold BI to MariaDB data source

The Bold BI Dashboard Designer supports connecting the MariaDB database using the SQL Live Query (C# API).

Choose MariaDB data source

To configure the MariaDB data source, follow these steps:

1. Click Data Sources in the configuration panel to add a new data connection.

   

2. Click CREATE NEW to launch a new connection from the connection panel.

3. Select the MariaDB connection in the connection panel.

   

NOTE: You can also create a data source from the home page by clicking the Data Sources menu from left menu panel and Create Data Source from the data sources page.

Connect to MariaDB

Create MariaDB data source

After clicking the data source, the NEW DATA SOURCE configuration panel opens. Follow the given steps to create a MariaDB data source:

1. Enter a name and description (optional) for the data source.

2. Enter a valid MariaDB server or host name in the ServerName text box.

3. Enter a valid MariaDB username in the UserName text box.

4. Enter a valid MariaDB password in the Password text box.

5. Select a database that you want to query in the listed database associated with the given MariaDB server in the database combo box.

   

To connect MariaDB with a particular table, enter the property currenttable={tablename} or specifictable={tablename} in the Additional connection parameters text box. The tables can be separated by comma {table1,table2} to connect with multiple tables.

NOTE: To connect data source with SSH, enable the SSH check box in the NEW DATA SOURCE configuration panel and enter the required credentials.

s

There are two connection types available in a data source:

* Live mode
* Extract mode

Live mode connection

In this connection type, a data source is directly fetched from source. Choose the Live mode option for this connection.

Data Preview

1. Click Connect to connect the MariaDB server with configured details.

The schema represents the collection list retrieved from the MariaDB server. This dialog displays a list of schemas in treeview and their corresponding values.

If the table name is provided in the Additional connection parameters text box, only the specified table will be listed.

2. Now, the data design view page with the selected table schema opens. Drag the table.

   

   You can use the Code View option for passing a query to display data.

   

3. Click Save to save the data source with a relevant name.

Extract mode connection

In this connection type, a data source is fetched from source periodically. Choose the Extract mode option for this connection.

NOTE: Initially, data will be extracted based on the Max Rows selected in order to proceed with data model creation. The remaining records (there is no limit) will be extracted during the next refresh.

Refresh Settings

Steps to configure the data source refresh settings:

1. Click Refresh Settings in the configuration panel.

   

2. Select the recurrence type, recurrence start, and end dates in the Refresh Setting dialog box.

   • Data refresh can be scheduled hourly, daily, weekly, and monthly.
   • Application Time Zone is displayed below the date picker. Start time of the schedule is converted to the client Time Zone and shown at the right-side for users convenience. After selecting, click Schedule.

   

Preview and data import

1. Click Connect to connect the MariaDB server with configured details.
2. The Extract data dialog opens. This dialog has two modes of connection either via Table or Custom query. Under custom query option, write the required query and click Connect.

Under Table option, This dialog displays a list of tables and views in treeview. Select the required table(s) or view(s) from treeview to use in the designer. Incremental Update can be performed in both tables and views. The option is available for configuring incremental refresh column for the selected items in the right-side panel. * The table must have a primary key column and date column to configure the incremental refresh option. * The Views must have a date column to configure the incremental refresh option and unique column(s) is optional which is used to update the modified records.

If you configured it, then the data source will work on Incremental update, otherwise works on Full load concept. And finally click Connect.

If the table name is provided in the Additional connection parameters text box, only the specified table will be listed for selection.

3. Now, the data design view page with the selected table schema opens. Drag the table.

   

   You can use the Code View option for passing query to display data.

   

4. Click Save to save the data source with a relevant name.

NOTE: In future, you can edit the connection information for both live and extract mode connections using the Edit Connection option.

Connecting Bold BI to MariaDB Data Source via REST API

Prerequisites

Type while creating the data source needs to be mariadb.

Rest API - v4.0

Modes

Through the REST API, only the live mode data source can be created and edited.

Parameters for creating Data Source

Parameters for adding expressions when creating Data Source

Parameters for editing Data Source

NOTE: For editing Data Source via API. All the parameters are optional. The parameter which needs to be changed can be provided.

Parameters for modifying expressions when editing Data Source

Connection Sample for Table Mode

For creating connection:

"Connection":
{
"Servername": "string",
"Port": "string",
"Username": "string",
"Password": "string",
"Database": "string",
"Schemaname": "string",
"Tablename": "string",
"AdvancedSettings": "string",
"CommandTimeout": "string",
"IsSshConnection": "false",
"SshServerName": "string",
"SshPort": 0,
"SshUsername": "string",
"SshPassword": "string",
"Expressions" : [{
"Name": "Expression1",
"Expression" : "SUM(numeric expression)"
    },
    {
"Name": "Expression2",
"Expression" :  "UPPER(string expression)"
}]
}

For editing connection:

"Connection":
{
"Servername": "string",
"Port": "string",
"Username": "string",
"Password": "string",
"Database": "string",
"Schemaname": "string",
"Tablename": "string",
"AdvancedSettings": "string",
"CommandTimeout": "string",
"IsSshConnection": "false",
"SshServerName": "string",
"SshPort": 0,
"SshUsername": "string",
"SshPassword": "string",
"Expressions" : [{
"Name": "Expression1",
"Expression" : "SUM(numeric expression)",
"NewName" : "Sum",
"Action": "edit"
    },
    {
"Name": "Expression2",
"Expression" :  "UPPER(string expression)"
"Action": "delete"
}]
}

NOTE: Through Rest API, the data source can be created or edited with only one table. If different table is provided in edit data source, the table will be replaced. The widgets will be retained only if the schema is same as the previous table.

Connection Sample for Code View Mode

"Connection":
{
"Servername": "string",
"Port": "string",
"Username": "string",
"Password": "string",
"Database": "string",
"Query": "string",
"AdvancedSettings": "string",
"CommandTimeout": "string",
"IsSshConnection": "false",
"SshServerName": "string",
"SshPort": 0,
"SshUsername": "string",
"SshPassword": "string",
"Expressions" : [{
"Name": "Expression1",
"Expression" : "SUM(numeric expression)"
    },
    {
"Name": "Expression2",
"Expression" :  "UPPER(string expression)"
}]
}

Related links

Data Transformation

Editing a Data Connection

Dashboard Designer Walkthrough