
- Prerequisites β Set up your account and credentials before submitting an API request.
- Set up a driver β Download, install, and configure a Firebolt driver to send queries using the Firebolt API.
- Submit a query β Use a driver to connect to Firebolt and submit a query.
Prerequisites
Before you submit API queries, you need the following:- A Firebolt account β Ensure that you have access to an active Firebolt account. If you donβt have access, you can sign up for an account. For more information about how to register with Firebolt, see Get started with Firebolt.
- A Firebolt service account β You must have access to an active Firebolt service account, which facilitates programmatic access to Firebolt.
- A user associated with the Firebolt service account β You must associate a user with your service account, and the user must have the necessary permissions to run the query on the specified database using the specified engine.
- Sufficient permissions If you want to query user data through a specific engine, you must have sufficient permissions on the engine, as well as on any tables and databases you access.
Set up a driver
Drivers are software components that facilitate communication between applications and databases. Use a Firebolt driver to connect to a Firebolt database, authenticate securely, and run SQL statements with minimal setup. Use a Firebolt driver for the following:- Simplified API access β Manage authentication and request formatting, eliminating the need for manual API calls. Requires only installation and basic configuration to connect and run SQL statements.
- Optimized performance β Improve query processing and connection management for faster response times.
- Secure authentication β Use service accounts and industry-standard methods to ensure secure access.
- Node.js SDK β For JavaScript-based applications.
- Python SDK β For Python-based applications and data workflows.
- JDBC Driver β For Java applications.
- SQLAlchemy β For ORM-based integrations in Python.
- .NET SDK β For applications running on the .NET framework.
- Go SDK β For applications using the Go programming language.