Skip to content

Commit bd57d45

Browse files
describe connection parameters (#24)
1 parent 8e7cf44 commit bd57d45

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

src/firebolt/db/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,16 @@
11
# Firebolt DB API
22
The Firebolt DB API is a Python 3 implementation of PEP-249 for Firebolt.
33

4+
## Connection parameters
5+
These parameters are used to connect to a Firebolt database:
6+
- **engine_url** - url for an engine to make requests to. Can be retrieved from Web UI, or from [engine](../models/engine.py#L57) attribute `endpoint`
7+
- **database** - name of the database to make queries to
8+
- **username** - account username
9+
- **password** - account password
10+
11+
Optional parameters
12+
- **api_endpoint** - api hostname for logging in. Defaults to `api.app.firebolt.io`.
13+
414
## Examples
515
See [PEP-249](https://www.python.org/dev/peps/pep-0249) for the DB API reference and specifications. An example [jupyter notebook](examples.ipynb) is included to illustrate the use of the Firebolt API.
616

0 commit comments

Comments
 (0)