Bold BI Client Library Installation Guide
Client Library Installation in Bold BI:
When working with Bold BI Data sources, you may encounter a situation where the client library is missing. This typically occurs if the Client libraries were not installed during the Bold BI installation process.
To resolve this issue, follow the steps below based on your deployment.
Windows deployment:
- Go to Bold BI installed location in your machine (C:\Program Files (x86)\Bold BI Enterprise Edition\Client Library).
- Run the ClientLibrary package installer.
- Select the required driver in the popup and click the install button.
| Data Source | Client Library |
|---|---|
| PostgreSQL | Npgsql 4.1.3 |
| MongoDB | Mongo-csharp-driver |
| Oracle | Oracle.ManagedDataAcces |
| MySQL | MySQLConnector 2.2.6 |
| Snowflake | Snowflake.Data |
| InfluxDB | InfluxData.Net |
| Athena | AWSSDK.Athena |
| Google Big Query | Google.Cloud.BigQuery.V2 |
| Clickhouse | ClickHouse.Client |
-
This will copy the required DLLs to the appropriate location in your Bold BI installation folder.
-
Now, you should be able to connect to your data source without any issues.
The sample dashboards use pre-configured database connections, and it is not recommended to switch the sample dashboards from their default connection (PostgreSQL) to other connections. Also, for the sample dashboard, we need to install the client library.
Kubernetes deployment:
If you are utilizing helm, please perform the following steps:
-
Add the optional library name in the helm values.yaml file as shown below.
*optionalLibs: 'mongodb,mysql,influxdb,snowflake,oracle,clickhouse,google.'*
-
Then upgrade the Bold BI, run the below command.
helm upgrade [RELEASE_NAME] boldbi/boldbi -f [Crafted values.yaml file] -n [Namespcace]
Example command:
helm upgrade boldbi boldbi/boldbi -f gke-values.yaml -n bold-services.
-
Once the upgrade is completed, ensure the client library installation in dataservice pod logs by running the below command.
kubectl logs [bi-dataservice-pod-name] -n [Namespace]
- Now, you should be able to connect to your MongoDB database without any issues.
If you are using kubectl, please perform the following steps:
- Open the deployment.yaml file and update the client library names in the specified section as shown below.
- In the terminal, navigate to the deployment.yaml file directory and run: the command to apply the changes.
Docker deployment:
Run the Below command to install the client libraries by passing the name as environment variable.
Bold BI in docker - https://hub.docker.com/r/syncfusion/boldbi
Linux deployment:
Follow the steps given here to install client libraries in Linux deployment.
Azure ARM deployment:
Follow the steps given here to install client libraries in Linux deployment.
Additional Reference:
