Connecting Bold BI to Rockset data source

The Bold BI dashboard designer supports connecting to Rockset database through SQL Live Query (REST API).

Choose Rockset data source

To configure the Rockset data source, follow the below steps:

Click on the Data Sources button in the configuration panel to add a new data connection.
Click CREATE NEW to launch a new connection from the connection panel.
Select the Rockset connection in the connection panel.

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

Choose data source from server

Connect to Rockset

Create Rockset data source

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

Enter a name and description (optional) for the data source.
Choose the region endpoint of the server from the Region Endpoint drop-down.
Enter a valid Rockset secret key in the ApiKey text box.
Select a Workspace that you want to query from the list of Workspaces associated with the given Rockset server in the Workspace drop-down menu.

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

Data Preview

Click Connect to connect the Rockset server with configured details.

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

Treeview schema

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

Alternatively, you can use the Code View options for passing a query to display data.
Click Save to save the data source with a relevant name.

Connect using custom attribute and dashboard parameter

We have added support for custom attributes and dashboard parameters in the data source connection. You can now connect to the data source using custom attributes or dashboard parameters.

Custom Attribute

Custom

Dashboard Parameter

Dashboard Parameter

Note: Refer to the Dashboard Parameter Documentation and Custom Attributes Documentation for more details.

Connecting Bold BI to Rockset Data Source via REST API

Prerequisites

Type while creating the data source needs to be Rockset.

Rest API - v4.0

Parameters for creating Data Source

NOTE: The ability to provide join support is only available during the creation of a new data source. Join in edit connection mode is not supported.

Parameters	Details
RegionEndpoint required	`string` Region in which the server is available The region Base URL must be provided. Examples: api.usw2a1.rockset.com, api.use1a1.rockset.com , and more.
ApiKey required	`string` Api key of the account.
WorkSpaces required	`string` Workspace 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
JoinType Required For Join Info	`string` Enter a valid JoinType For Example (Inner,Outer)
LeftTable Required For Join Info	`string` Enter a valid Left Table name
RightTable Required For Join Info	`string` Enter a valid Right Table name
LeftField Required For Join Info	`string` Enter a valid Left Table Column Name
RightField Required For Join Info	`string` Enter a valid Right Table Column Name
Condition Required For Join Info	`string` Enter a valid Condition For Example (AND,OR)
LeftField Required For Join Info	`string` Enter a valid Left Table Column Name
Operator Required For Join Info	`string` Enter a Valid Operator For Example (=,>=)
Value Optional For only Join Info	`string` Specifically choose the column values.
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: To edit the Data Source via API, all parameters are optional. Only provide the parameter that needs to be changed.

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

For creating connection with multiple tables :

"Connection":
{
"RegionEndpoint": "string",
"ApiKey": "string",
"WorkSpaces": "string",
"Tables": [
            {
                "Tablename": "string",
                "Schemaname": "string"
            },
            {
                "Tablename": "string",
                "Schemaname": "string"
            }
        ],
"JoinInfo": [
            {
                "JoinType": "string",
                "LeftTable": "string",
                "RightTable": "string",
                "JoinFieldInfos": [
                    {
                        "Condition": "string",
                        "LeftField": "string",
                        "Operator": "string",
                        "RightField": "string",
                        "Value": "string"
                    },
                    {
                        "Condition": "string",
                        "LeftField": "string",
                        "Operator": "string",
                        "RightField": "string",
                        "Value": "string"
                    }
                ]
            }
        ],
"AdvancedSettings": "string",
"Expressions" : [{
"Name": "Expression1",
"Expression" : "SUM(numeric expression)"
    },
    {
"Name": "Expression2",
"Expression" :  "UPPER(string expression)"
}]
}

For editing connection:

"Connection":
{
"RegionEndpoint": "string",
"ApiKey": "string",
"WorkSpaces": "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 the 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":
{
"RegionEndpoint": "string",
"ApiKey": "string",
"WorkSpaces": "string",
"Schemaname": "string",
"Tablename": "string",
"AdvancedSettings": "string",
"Expressions" : [{
"Name": "Expression1",
"Expression" : "SUM(numeric expression)"
    },
    {
"Name": "Expression2",
"Expression" :  "UPPER(string expression)"
}]
}