Skip to content

Commit c209b52

Browse files
committed
Updates to Postgres instructions and PR sectioning
1 parent 9e7c220 commit c209b52

File tree

1 file changed

+62
-4
lines changed

1 file changed

+62
-4
lines changed

docs/docs/releases/0.2.1.md

+62-4
Original file line numberDiff line numberDiff line change
@@ -11,30 +11,47 @@ _This page provides a comprehensive list of all changes since version [0.2.0](./
1111
<!-- ## Breaking changes -->
1212
<!-- (This section lists any breaking changes to publicly exposed and documented machine interfaces to Mathesar such as the API or DB functions) -->
1313

14-
1514
## Improvements
1615
<!-- (Each feature within this section should have its own level-three heading) -->
1716

1817
### Database nicknames
1918

19+
[TODO]
20+
2021
[#4262](https://github.com/mathesar-foundation/mathesar/pull/4262 "Frontend support for databases nicknames")
2122
[#4244](https://github.com/mathesar-foundation/mathesar/pull/4244 "Backend support for database nicknames")
2223
[#4261](https://github.com/mathesar-foundation/mathesar/pull/4261 "Allow DB name/host/port to be updated")
2324

2425
### In-app feedback
2526

27+
[TODO]
28+
2629
[#4241](https://github.com/mathesar-foundation/mathesar/pull/4241 "Move feedback to app header, add mailing list link to home page")
2730

2831
### Column widths are persisted
2932

33+
[TODO]
34+
3035
[#4257](https://github.com/mathesar-foundation/mathesar/pull/4257 "Persist column width")
3136
[#4248](https://github.com/mathesar-foundation/mathesar/pull/4248 "Backend support to persist customized column widths")
3237

38+
### Drop schema contents when deleting
39+
40+
[TODO]
41+
42+
43+
It's new behavior for Mathesar.
44+
It's novel in the field, AFAIK. No other product (that I'm aware of) has the same combination of safety and convenience provided by this.
45+
It warrants a bit more description, since the difference between this and CASCADE may surprise or interest a knowledgeable user, and may make some more confident when letting their users use Mathesar to access the DB.
46+
47+
48+
[#4251](https://github.com/mathesar-foundation/mathesar/pull/4251 "Drop schema contents when deleting")
49+
3350
### Docker Compose installs are updated to Postgres 17
3451

3552
!!! info "For existing users"
3653

37-
Existing users who would like to update to Postgres 17 should use our new docker compose file and run `cp -r msar msar.backup` prior to upgrading Postgres in the event of issues.
54+
See the [upgrading Postgres](#upgrading-postgres) section for instructions on safely upgrading your Postgres version.
3855

3956
New installs of Mathesar using our recommended [Docker Compose](../administration/install-via-docker-compose.md) installation will now use Postgres 17. Prior to 1.2.1 Mathesar installs configured via our docker compose file used version 13.
4057

@@ -46,11 +63,13 @@ _This page provides a comprehensive list of all changes since version [0.2.0](./
4663
[#4252](https://github.com/mathesar-foundation/mathesar/pull/4252 "Partially support passwordless Database Roles")
4764
[#4255](https://github.com/mathesar-foundation/mathesar/pull/4255 "Copy suggestions for passwordless roles in Mathesar")
4865

49-
## Bug fixes
66+
### Additional features
5067

51-
- Drop schema contents when deleting [#4251](https://github.com/mathesar-foundation/mathesar/pull/4251 "Drop schema contents when deleting")
5268
- Backend changes to support CSV file imports with an id column [#4269](https://github.com/mathesar-foundation/mathesar/pull/4269 "Backend changes to support CSV file imports with an id column")
5369
- Allow patching records in tables with non-integer primary keys [#4246](https://github.com/mathesar-foundation/mathesar/pull/4246 "Allow patching records in tables with non-integer primary keys")
70+
71+
## Bug fixes
72+
5473
- Use binary reads and writes whenever possible [#4254](https://github.com/mathesar-foundation/mathesar/pull/4254 "Use binary reads and writes whenever possible") [#4272](https://github.com/mathesar-foundation/mathesar/pull/4272 "Revert read mode in mathesar_ui")
5574
- Fix bug in RichText parsing [#4209](https://github.com/mathesar-foundation/mathesar/pull/4209 "Fix bug in RichText parsing")
5675
- introduce the showLoadingSpinner prop in TableView.svelte [#4222](https://github.com/mathesar-foundation/mathesar/pull/4222 "introduce the showLoadingSpinner prop in TableView.svelte")
@@ -75,6 +94,45 @@ The following PRs represent work done to reduce technical debt, update dependenc
7594
[#4146](https://github.com/mathesar-foundation/mathesar/pull/4146 "Bump django from 4.2.17 to 4.2.18")
7695
[#4253](https://github.com/mathesar-foundation/mathesar/pull/4253 "Remove unused demo telemetry code")
7796

97+
## Upgrading to Postgres 17 {:#upgrading-postgres}
98+
99+
Follow these steps to upgrade Postgres to the latest version. Note that this upgrade is only necessary for existing Mathesar users who would like to switch to the latest version of Postgres.
100+
101+
1. Navigate to your installation directory.
102+
2. Shut down Mathesar with `docker compose down`.
103+
3. Create a backup of your installation with `cp -r msar msar.backup`. Keep the `msar.backup` folder in a safe location.
104+
4. Back up your existing Docker Compose configuration with `cp docker-compose.yml docker-compose.yml.backup`.
105+
5. Download the latest Docker Compose file with:
106+
```
107+
wget https://github.com/mathesar-foundation/mathesar/raw/0.2.1/docker-compose.yml
108+
```
109+
6. Edit the new `docker-compose.yml` file to restore any personal variables or custom configurations from your backup.
110+
7. Restart Mathesar with the latest images:
111+
```
112+
docker compose up --pull always -d
113+
```
114+
8. Once you've confirmed everything is working correctly, you can delete the backup files.
115+
116+
### Troubleshooting & rolling back
117+
118+
If you encounter issues or the upgrade fails:
119+
120+
1. Restore the previous `docker-compose.yml`:
121+
```
122+
mv docker-compose.yml.backup docker-compose.yml
123+
```
124+
2. Restore your Mathesar installation:
125+
```
126+
rm -rf msar && mv msar.backup msar
127+
```
128+
3. Start Mathesar again:
129+
```
130+
docker compose up -d
131+
```
132+
133+
For additional support, reach out to the Mathesar team via a [GitHub issue](https://github.com/mathesar-foundation/mathesar/issues/new/choose) or the [Matrix chat](https://wiki.mathesar.org/en/community/matrix).
134+
135+
78136
## Upgrading to 0.2.1 {:#upgrading}
79137

80138
### For installations using Docker Compose

0 commit comments

Comments
 (0)