You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/firebolt/db/README.md
+10Lines changed: 10 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,16 @@
1
1
# Firebolt DB API
2
2
The Firebolt DB API is a Python 3 implementation of PEP-249 for Firebolt.
3
3
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
+
4
14
## Examples
5
15
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.
0 commit comments