Requirements:
- Active Firebolt account and setup.
- Ensure the necessary service account, role, and user permissions are configured for connectivity.
Setup Guide:
-
Create a Service Account:
- Log in to your Firebolt account.
- Navigate to the Configure tab and select the Service Accounts section.
- Click CREATE to establish a new service account.
-
Assign Roles:
- Go to the Govern tab and create a new role.
- Assign the role the permissions to use any database and use any engine.
-
Create a User:
- Create a user within Firebolt and assign the newly created role to the user.
-
Retrieve Service Account Keys:
- Return to the Service Accounts section.
- Copy the Client_ID and Client_Secret for the created service account.
-
Fill Up Connection Info:
Provide the necessary information to connect to your Firebolt account in Databrain:- Integration Name: Pick a name to help you identify this source in Databrain.
- Firebolt Datasource: Select Firebolt as your data source.
- Client_ID: Copy and paste the Client_ID retrieved from the service account.
- Client Secret: Copy and paste the Client_ID retrieved from the service account.
- Account Name: Provide the account name for your Firebolt setup.
- Database Name: Enter the name of the database.
- Engine Name: Specify the name of the engine (e.g., my_engine).
- Schema: Provide the schema name to be used.
-
Test the Connection:
- Use the Add a Data Source UI in Databrain to verify that the connection is successful.
Locating the Configuration Details in Firebolt:
-
Service Account Client_Secret & Client_ID:
- These are found under the Service Accounts tab in the Firebolt Configure section.
-
Role Permissions:
- Verify roles and permissions in the Govern tab. Ensure the role has access to all required databases and engines.
-
Database and Engine Details:
- Review your Firebolt account dashboard to confirm database and engine configurations.
Notes:
- Ensure you are using the correct Client_Secret and Client_ID for your service account.
- Maintain the security of your credentials to prevent unauthorized access.
Troubleshooting intermittent failures
If the Firebolt connection works sometimes and fails at other times, work through these in order:- Capture the exact error. Open the data source in DataBrain and hit Test connection a few times — note whether the message changes between attempts. An auth error that appears only intermittently usually means an expired service-account token being refreshed mid-request.
- Engine state. Firebolt engines can auto-stop when idle. If the first query after a quiet period fails and the retry succeeds, the engine was cold-starting. Check the engine’s auto-stop setting in Firebolt, or use an always-on engine for embedded dashboards.
- Role scope. Confirm the service account’s role has use any database and use any engine (or explicit grants covering the configured database and engine). A role change in Firebolt takes effect on new connections, which looks intermittent while old connections drain.
- Concurrency limits. Dashboards fire several metric queries at once. If failures correlate with dashboard loads (not single metrics), the engine may be hitting its concurrency limit — scale the engine or reduce simultaneous metrics.
- Still failing? Contact support with the exact error string, the time window, and whether Test connection reproduces it — intermittent driver-level issues need the failing query and timestamp to trace.

