diff --git a/data_safe_haven/resources/workspace/ansible/host_vars/localhost.yaml b/data_safe_haven/resources/workspace/ansible/host_vars/localhost.yaml index f6900fcd7c..55ee5e6340 100644 --- a/data_safe_haven/resources/workspace/ansible/host_vars/localhost.yaml +++ b/data_safe_haven/resources/workspace/ansible/host_vars/localhost.yaml @@ -145,7 +145,6 @@ deb_packages: snap_packages: - name: codium classic: true - - name: dbeaver-ce - classic: false + - name: beekeeper-studio - name: pycharm-community classic: true diff --git a/data_safe_haven/resources/workspace/ansible/tasks/packages.yaml b/data_safe_haven/resources/workspace/ansible/tasks/packages.yaml index 9b01bfa6c8..584e3a1b24 100644 --- a/data_safe_haven/resources/workspace/ansible/tasks/packages.yaml +++ b/data_safe_haven/resources/workspace/ansible/tasks/packages.yaml @@ -29,7 +29,7 @@ tags: snap community.general.snap: name: "{{ item.name }}" - classic: "{{ item.classic }}" + classic: "{{ item.classic | default('false') }}" state: present loop: "{{ snap_packages }}" diff --git a/docs/source/roles/researcher/images/db_beekeeper_studio_mssql.png b/docs/source/roles/researcher/images/db_beekeeper_studio_mssql.png new file mode 100644 index 0000000000..fede151a4a Binary files /dev/null and b/docs/source/roles/researcher/images/db_beekeeper_studio_mssql.png differ diff --git a/docs/source/roles/researcher/images/db_beekeeper_studio_postgres.png b/docs/source/roles/researcher/images/db_beekeeper_studio_postgres.png new file mode 100644 index 0000000000..473f40cda2 Binary files /dev/null and b/docs/source/roles/researcher/images/db_beekeeper_studio_postgres.png differ diff --git a/docs/source/roles/researcher/images/db_dbeaver_connect_mssql.png b/docs/source/roles/researcher/images/db_dbeaver_connect_mssql.png deleted file mode 100644 index 273d53a993..0000000000 Binary files a/docs/source/roles/researcher/images/db_dbeaver_connect_mssql.png and /dev/null differ diff --git a/docs/source/roles/researcher/images/db_dbeaver_connect_postgresql.png b/docs/source/roles/researcher/images/db_dbeaver_connect_postgresql.png deleted file mode 100644 index ac1e79cf76..0000000000 Binary files a/docs/source/roles/researcher/images/db_dbeaver_connect_postgresql.png and /dev/null differ diff --git a/docs/source/roles/researcher/images/db_dbeaver_driver_download.png b/docs/source/roles/researcher/images/db_dbeaver_driver_download.png deleted file mode 100644 index a2225657b1..0000000000 Binary files a/docs/source/roles/researcher/images/db_dbeaver_driver_download.png and /dev/null differ diff --git a/docs/source/roles/researcher/images/db_dbeaver_select_mssql.png b/docs/source/roles/researcher/images/db_dbeaver_select_mssql.png deleted file mode 100644 index ea5b7e9e41..0000000000 Binary files a/docs/source/roles/researcher/images/db_dbeaver_select_mssql.png and /dev/null differ diff --git a/docs/source/roles/researcher/images/db_dbeaver_select_postgresql.png b/docs/source/roles/researcher/images/db_dbeaver_select_postgresql.png deleted file mode 100644 index 75f0d019d3..0000000000 Binary files a/docs/source/roles/researcher/images/db_dbeaver_select_postgresql.png and /dev/null differ diff --git a/docs/source/roles/researcher/snippets/software_database.partial.md b/docs/source/roles/researcher/snippets/software_database.partial.md index e47f443c17..d76766476e 100644 --- a/docs/source/roles/researcher/snippets/software_database.partial.md +++ b/docs/source/roles/researcher/snippets/software_database.partial.md @@ -1,3 +1,3 @@ -- `DBeaver` desktop database management software +- `Beekeeper Studio` desktop database management software - `psql` a command line PostgreSQL client - `unixodbc-dev` driver for interacting with Microsoft SQL databases diff --git a/docs/source/roles/researcher/using_the_sre.md b/docs/source/roles/researcher/using_the_sre.md index 41752c1c06..51a7b60abf 100644 --- a/docs/source/roles/researcher/using_the_sre.md +++ b/docs/source/roles/researcher/using_the_sre.md @@ -529,7 +529,7 @@ Official tutorials for [MSSQL](https://learn.microsoft.com/en-us/sql/sql-server/ :class: dropdown note - **Server name** : mssql._SRE\_URL_ (e.g. mssql.sandbox.projects.example.org) -- **Username**: databaseadmin +- **Username**: databaseadmin@shm-_SHM\_NAME_-sre-_SRE\_NAME_-db-server-mssql - **Password**: provided by your {ref}`System Manager ` - **Database name**: provided by your {ref}`System Manager ` - **Port**: 1433 @@ -547,111 +547,57 @@ Official tutorials for [MSSQL](https://learn.microsoft.com/en-us/sql/sql-server/ ::: -Examples are given below for connecting using **DBeaver**, **Python** and **R**. +Examples are given below for connecting using **Beekeeper Studio**, **Python** and **R**. The instructions for using other graphical interfaces or programming languages will be similar. -### {{bear}} Connecting using DBeaver - -#### Microsoft SQL +### {{bee}} Connecting using Beekeeper Studio -::::{admonition} 1. Create new Microsoft SQL server connection +::::{admonition} Microsoft SQL :class: dropdown note -Click on the **{guilabel}`New database connection`** button (which looks a bit like an electrical plug with a plus sign next to it) - +- Click on the **{guilabel}`+ New Connection`** button - Select **SQL Server** as the database type - - :::{image} images/db_dbeaver_select_mssql.png - :alt: DBeaver select Microsoft SQL +- Enter the connection details + - **Authentication**: Username/Password + - **Host**: as above + - **Port**: as above + - **Enable SSL**: false + - **User**: as above + - **Password**: as above + - **Domain**: empty + - **Trust Server Certificate**: true + - **Default Database**: master +- Click on **{guilabel}`Test`** to test the connection settings +- Click on **{guilabel}`Connect`** to connect to the database or enter a name and click **{guilabel}`Save`** to save the connection settings for future use + + :::{image} images/db_beekeeper_studio_mssql.png + :alt: Beekeeper Studio MS SQL connection configuration :align: center :width: 90% ::: - -:::: - -::::{admonition} 2. Provide connection details -:class: dropdown note - -- **Host**: as above -- **Database**: as above -- **Authentication**: SQL Server Authentication -- **Username**: as above -- **Password**: as above -- Tick **Show All Schemas** -- Tick **Trust server certificate** - - :::{image} images/db_dbeaver_connect_mssql.png - :alt: DBeaver connect with Microsoft SQL - :align: center - :width: 90% - ::: - -:::: - -::::{admonition} 3. Download drivers if needed -:class: dropdown note - -- After clicking finish, you may be prompted to download driver files even though they should be pre-installed. -- Click on the **{guilabel}`Download`** button if this happens. - - :::{image} images/db_dbeaver_driver_download.png - :alt: DBeaver driver download for Microsoft SQL - :align: center - :width: 90% - ::: - -- If drivers are not available contact your {ref}`System Manager ` - :::: -#### PostgreSQL - -::::{admonition} 1. Create new PostgreSQL server connection -:class: dropdown note - -Click on the **{guilabel}`New database connection`** button (which looks a bit like an electrical plug with a plus sign next to it) - -- Select **PostgreSQL** as the database type - - :::{image} images/db_dbeaver_select_postgresql.png - :alt: DBeaver select PostgreSQL - :align: center - :width: 90% - ::: - -:::: - -::::{admonition} 2. Provide connection details -:class: dropdown note - -- **Host**: as above -- **Database**: as above -- **Authentication**: Database Native -- **Username**: as above -- **Password**: as above - - :::{image} images/db_dbeaver_connect_postgresql.png - :alt: DBeaver connect with PostgreSQL - :align: center - :width: 90% - ::: - -:::: - -::::{admonition} 3. Download drivers if needed +::::{admonition} PostgreSQL :class: dropdown note -- After clicking finish, you may be prompted to download driver files even though they should be pre-installed. -- Click on the **{guilabel}`Download`** button if this happens. - - :::{image} images/db_dbeaver_driver_download.png - :alt: DBeaver driver download for PostgreSQL +- Click on the **{guilabel}`+ New Connection`** button +- Select **Postgres** as the database type +- Enter the connection details + - **Connection Mode**: Host and Port + - **Host**: as above + - **Port**: as above + - **Enable SSL**: false + - **User**: as above + - **Password**: as above + - **Default Database**: postgres +- Click on **{guilabel}`Test`** to test the connection settings +- Click on **{guilabel}`Connect`** to connect to the database or enter a name and click **{guilabel}`Save`** to save the connection settings for future use + + :::{image} images/db_beekeeper_studio_postgres.png + :alt: Beekeeper Studio PostgreSQL connection configuration :align: center :width: 90% ::: - -- If drivers are not available contact your {ref}`System Manager ` - :::: ### {{snake}} Connecting using Python