Skip to content

docs: remove embedded PostgreSQL backup instructions from upgrade guide #807

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 12, 2025
Merged

docs: remove embedded PostgreSQL backup instructions from upgrade guide #807

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
30 changes: 3 additions & 27 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 @@ -22,19 +22,17 @@ Start Bytebase with the new version using your existing Docker run command, upda
**Production Safety:** Validate your upgrade procedure in a staging environment before executing it in production.
</Warning>

## Back up and Restore
## Back up and Restore (External PostgreSQL)

### External PostgreSQL (Recommended)

#### Creating a Backup
### Creating a Backup

Execute the following command to create a complete database clone:

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

#### Restoring from Backup
### Restoring from Backup

1. Stop your Bytebase instance completely.

Expand All @@ -59,25 +57,3 @@ Execute the following command to create a complete database clone:
psql -h <<host>> -p <<port>> -U <<user>> postgres -c "DROP DATABASE metadb_backup"
```

### Embedded PostgreSQL

#### Creating a Backup

Archive your entire data directory to preserve the embedded database:

```text
tar -czf bytebase-backup.tar.gz /path/to/data
```

#### Restoring from Backup

Follow these steps to restore your embedded PostgreSQL data:

1. Stop your Bytebase instance completely
2. Extract and replace the data directory from your backup:

```text
tar -xzf bytebase-backup.tar.gz -C /
```

3. Start Bytebase with the previous version using the restored data directory