Search results

Connecting Bold BI to the Clickhouse Data Source

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

How to create Clickhouse data source

To configure the Clickhouse data source, follow these steps:

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

    Data source icon

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

  3. Select the Clickhouse connection in the connection panel.

    Choose data source

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.

Choose data source

Connect to Clickhouse

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

  1. Enter a name and description (optional) for the data source.
  2. Enter a valid server or host name in the Server Name text box.
  3. Enter the username in the Username text box and password in the Password text box.
  4. Enter the database name in the database text box.
  5. Click Connect to connect the Clickhouse server with the configured details.

Clickhouse Connection

Data Preview

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

    Treeview schema

  2. Drag and drop any table and Click update button to preview the data.

    Query designer

  3. By default, the data design view opens with design view. Switch to the code view by enabling the slider option in the tools pane in data design view as shown in the below image.

    Codeview mode

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

NOTE: In future, you can edit the connection information using the Edit Connection option.

Connecting Bold BI to Clickhouse Data Source via REST API

Prerequisites

Type while creating the data source needs to be clickhouse.

Rest API - v4.0

Parameters for creating Data Source

Parameters Details
Servername

required
`string`

Server name or Host name of the connection
Port

required
`string`

Port number used to connect to clickhouse

Username

required
`string`

A valid Username for the connection
Password

required
`string`

A valid Password for the connection
Database

required
`string`

database which needs to be connected
Schemaname

required for table mode
`string`

Enter a valid Schemaname
Tablename

required for table mode
`string`

Enter a valid Tablename
Query

required for code view mode
`string`

Enter a valid Query
AdvancedSettings

optional
`string`

Additional optional connection parameters can be provided. By default, it is empty.
Expressions

optional

`Array of Objects`



Parameters for adding expressions when creating Data Source

Parameters Details
Name

required

`string`

Name of the Expression

Expression



required

`string`

Expression


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

Parameters Details
Name

required

`string`

Name of the Expression

Expression



required

`string`

Expression


Action



optional

`string`

add/delete/edit

By default, it is add

NewName

optional

`string`

For renaming the expression. This is applicable only if the Action is edit

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",
"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",
"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",
"Expressions" : [{
"Name": "Expression1",
"Expression" : "SUM(numeric expression)"
    },
    {
"Name": "Expression2",
"Expression" :  "UPPER(string expression)"
}]
}
]

Data Transformation

Editing a Data Connection

Dashboard Designer Walkthrough