Skip to content

docs: simplify PostgreSQL commands in upgrade guide #818

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
d-bytebase merged 1 commit into from
Aug 13, 2025
Merged

docs: simplify PostgreSQL commands in upgrade guide #818

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 9 additions & 9 deletions mintlify/get-started/self-host/upgrade.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ Start Bytebase with the new version using your existing Docker run command, upda

Execute the following command to create a complete database clone:

```bash
psql -h <<host>> -p <<port>> -U <<user>> metadb -c "CREATE DATABASE metadb_backup WITH TEMPLATE metadb;"
```sql
CREATE DATABASE metadb_backup WITH TEMPLATE metadb;
```

### Restoring from Backup
Expand All @@ -38,22 +38,22 @@ psql -h <<host>> -p <<port>> -U <<user>> metadb -c "CREATE DATABASE metadb_backu

2. Preserve the current database by renaming it:

```bash
psql -h <<host>> -p <<port>> -U <<user>> postgres -c "ALTER DATABASE metadb RENAME TO metadb_old"
```sql
ALTER DATABASE metadb RENAME TO metadb_old;
```

3. Restore from your backup:

```bash
psql -h <<host>> -p <<port>> -U <<user>> postgres -c "CREATE DATABASE metadb WITH TEMPLATE metadb_backup;"
```sql
CREATE DATABASE metadb WITH TEMPLATE metadb_backup;
```

4. Start Bytebase with the previous version (the version you were running before the failed upgrade).

5. After confirming successful restoration, remove temporary databases:

```bash
psql -h <<host>> -p <<port>> -U <<user>> postgres -c "DROP DATABASE metadb_old"
psql -h <<host>> -p <<port>> -U <<user>> postgres -c "DROP DATABASE metadb_backup"
```sql
DROP DATABASE metadb_old;
DROP DATABASE metadb_backup;
```