Skip to content

docs: Adding account name #48

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 10, 2022
Merged

docs: Adding account name #48

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f31266a
docs: Adding account name
ptiurin Feb 7, 2022
e380727
Adding spacing
ptiurin Feb 7, 2022
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
10 changes: 9 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,18 +22,26 @@ pip install firebolt-sqlalchemy
Connection strings use the following structure:

```
firebolt://{username}:{password}@{database}[/{engine_name}]
firebolt://{username}:{password}@{database}[/{engine_name}][?account_name={name}}]
```

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

`account_name` is optional. If omitted a default account will be used for connection.

Examples:

```
firebolt://email@domain:password@sample_database
firebolt://email@domain:password@sample_database/sample_engine
```

If a different account name is required, it can be specified in the connection string

```
firebolt://email@domain:password@sample_database/sample_engine?account_name=my_account
```

To override the API URL (e.g. for dev testing):

```bash
Expand Down