Skip to content

Commit 6f17d39

Browse files
authored
chore: Add readme (#2)
1 parent e6263c3 commit 6f17d39

File tree

1 file changed

+45
-0
lines changed

1 file changed

+45
-0
lines changed

README.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Firebolt Power BI Connector
2+
3+
This repository provides the Firebolt connector for Microsoft Power BI, allowing users to seamlessly integrate Firebolt data sources with Power BI for advanced analytics and reporting.
4+
5+
## Prerequisites
6+
7+
Before installing the connector, ensure you have Firebolt's ODBC driver installed on your machine. If you don't have the driver, please reach out to your Firebolt representative to obtain it. Once obtained, run the provided installation file and follow the installation wizard instructions to install the driver.
8+
9+
## Installation
10+
11+
1. Navigate to the [GitHub Releases](https://github.com/firebolt-db/power-bi-firebolt/releases) page.
12+
2. Download the latest `.mez` connector file.
13+
3. Place the downloaded `.mez` file into your Power BI custom connectors directory:
14+
```
15+
Documents\Power BI Desktop\Custom Connectors
16+
```
17+
18+
### Enable custom connectors in Power BI Desktop
19+
20+
Power BI Desktop requires explicit permission to load custom connectors. To ensure the Firebolt connector loads correctly, you must enable loading of custom connectors without validation:
21+
22+
1. Restart Power BI Desktop.
23+
2. Go to `File``Options and settings``Options``Security`.
24+
3. Under `Data Extensions`, select "Allow any extension to load without validation or warning."
25+
*(This step is necessary because custom connectors are not signed by Microsoft and Power BI Desktop blocks unsigned connectors by default for security reasons.)*
26+
4. Restart Power BI Desktop again to apply changes.
27+
28+
## Adding Firebolt as a Data Source in Power BI
29+
30+
1. Open Power BI Desktop.
31+
2. Click on `Get Data``More...`.
32+
3. In the dialog, search for "Firebolt" and select the Firebolt connector.
33+
4. Click `Connect`.
34+
5. Enter your Firebolt connection details:
35+
- **Account**: Your Firebolt account name.
36+
- **Engine**: The name of the Firebolt engine you want to connect to.
37+
- **Database**: The name of your Firebolt database.
38+
6. Select the Data Connectivity mode:
39+
- **Import**: Data is loaded into Power BI, enabling extensive functionality but requiring periodic refreshes and sufficient local memory to accommodate the dataset.
40+
- **DirectQuery**: Queries are executed directly on Firebolt in real-time, providing fast performance even on large datasets by leveraging Firebolt's optimized query engine.
41+
7. Click `OK`.
42+
8. Enter your service account credentials. Follow the [guide](https://docs.firebolt.io/guides/managing-your-organization/service-accounts#create-a-service-account) to generate them if you don't have them already.
43+
- **Client ID**: Your Firebolt service account id.
44+
- **Client Secret**: Your Firebolt service account secret.
45+
6. Click `Connect` to establish the connection.

0 commit comments

Comments
 (0)