Skip to content

Commit e7a96f2

Browse files
authored
docs: Add Core example to readme (#107)
1 parent aea6dd5 commit e7a96f2

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,23 @@ import urllib.parse
5757
new_secret = urllib.parse.quote_plus(my_secret)
5858
```
5959

60+
## Connecting with Firebolt Core
61+
62+
[Firebolt Core](https://docs.firebolt.io/firebolt-core) is free self-hosted version of Firebolt.
63+
64+
In order to connect to it you can provide a simplified version of the connection string:
65+
66+
```
67+
firebolt://{database}?url={url}
68+
```
69+
70+
`{database}` is you Firebolt Core database. By default this is `firebolt`
71+
72+
`{url}` is a fully qualified URL (with port) where your Firebolt Core is hosted. By default it's `http://localhost:3473`
73+
74+
If you are running Firebolt Core locally with defaults the connection string will be `firebolt://firebolt?url=http://localhost:3473`
75+
76+
6077
## Quick Start
6178

6279
```python

0 commit comments

Comments
 (0)