Skip to content

Commit d87ce51

Browse files
authored
docs: Adding account name (#48)
1 parent 7b25021 commit d87ce51

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,18 +22,26 @@ pip install firebolt-sqlalchemy
2222
Connection strings use the following structure:
2323

2424
```
25-
firebolt://{username}:{password}@{database}[/{engine_name}]
25+
firebolt://{username}:{password}@{database}[/{engine_name}][?account_name={name}}]
2626
```
2727

2828
`engine_name` is optional. If omitted, Firebolt will use the default engine for the database.
2929

30+
`account_name` is optional. If omitted a default account will be used for connection.
31+
3032
Examples:
3133

3234
```
3335
firebolt://email@domain:password@sample_database
3436
firebolt://email@domain:password@sample_database/sample_engine
3537
```
3638

39+
If a different account name is required, it can be specified in the connection string
40+
41+
```
42+
firebolt://email@domain:password@sample_database/sample_engine?account_name=my_account
43+
```
44+
3745
To override the API URL (e.g. for dev testing):
3846

3947
```bash

0 commit comments

Comments
 (0)