Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .env

This file was deleted.

8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,10 @@ firebolt://email@domain:password@sample_database
firebolt://email@domain:password@sample_database/sample_engine
```

To override the API url (e.g. for dev testing)
```bash
export FIREBOLT_BASE_URL=<your_url>
```

## DB API

Expand Down Expand Up @@ -72,9 +76,7 @@ schemas = dialect.get_schema_names(connection)
```

## Components in the Adapter:
1. Firebolt Connector: This file is used to establish a connection to the Firebolt database from 3rd party applications. It provides a ‘connect’ method which accepts parameters like database name, username, password etc. from the connecting application to identify the database and authenticate the user credentials. It returns a database connection which is used to execute queries on the database.
2. API Service: The API Service is responsible for calling Firebolt REST APIs to establish connection with the database and fire SQL queries on it. It provides methods to get access token as per user credentials, get the specific engine URL and execute/run SQL queries. Executing queries need access token and engine URL as per the Firebolt REST API specifications.
3. Firebolt Dialect: It provides methods for retrieving metadata about databases like schema data, table names, column names etc. It also maps the data types between Firebolt and SQLAlchemy along with providing a data type compiler for complex data types.
1. Firebolt Dialect: It provides methods for retrieving metadata about databases like schema data, table names, column names etc. It also maps the data types between Firebolt and SQLAlchemy along with providing a data type compiler for complex data types.


## Testing Strategy:
Expand Down
3 changes: 1 addition & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,7 @@
},
install_requires=[
'sqlalchemy>=1.0.0',
"requests",
"datetime"
"firebolt-sdk"
],
entry_points={
"sqlalchemy.dialects": [
Expand Down
4 changes: 2 additions & 2 deletions src/firebolt_db/__init__.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
from .firebolt_connector import connect
from .exceptions import (
from firebolt.db import connect
from firebolt.common.exception import (
DatabaseError,
DataError,
Error,
Expand Down
18 changes: 0 additions & 18 deletions src/firebolt_db/constants.py

This file was deleted.

53 changes: 0 additions & 53 deletions src/firebolt_db/exceptions.py

This file was deleted.

278 changes: 0 additions & 278 deletions src/firebolt_db/firebolt_api_service.py

This file was deleted.

Loading