Skip to content

Commit

Permalink
Update docs with instructions to download db drivers
Browse files Browse the repository at this point in the history
  • Loading branch information
craddm committed Jan 16, 2024
1 parent b35e31a commit 925aa2b
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions docs/source/roles/researcher/user_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -1002,6 +1002,18 @@ Our example user Ada Lovelace, working in the `sandbox` SRE on the `projects.tur
Be sure to select `Kerberos authentication` so that your username and password will be passed through to the database
```

````{note}
After clicking finish, you may be prompted to download missing driver files.
Drivers have already been provided on the SRD for Microsoft SQL databases.
Clicking `Download` will make DBeaver use these pre-downloaded drivers without requiring internet access.
Thus, even on SRDs with no external internet access (Tier 2 or above), click `Download`.
Note that the prompt may appear multiple times.
```{image} user_guide/db_dbeaver_mssql_download.png
:alt: DBeaver driver download for Microsoft SQL
:align: center
```
````

#### PostgreSQL

- Select `PostgreSQL` as the database type
Expand All @@ -1028,6 +1040,18 @@ If you are prompted for `Username` or `Password` when connecting, you can leave
```
````

````{note}
After clicking finish, you may be prompted to download missing driver files.
Drivers have already been provided on the SRD for PostgreSQL databases.
Clicking `Download` will make DBeaver use these pre-downloaded drivers without requiring internet access.
Thus, even on SRDs with no external internet access (Tier 2 or above), click `Download`.
Note that the prompt may appear multiple times.
```{image} user_guide/db_dbeaver_pstgrs_download.png
:alt: DBeaver driver download for Microsoft SQL
:align: center
```
````

### {{snake}} Connecting using Python

Database connections can be made using `pyodbc` or `psycopg2` depending on which database flavour is being used.
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 925aa2b

Please sign in to comment.