Upgrade

Make sure to back up the metadata before upgrading. You need the old version metadata to downgrade if needed.

Upgrade Process#

Take Docker as an example:

1. Stop Bytebase

   docker stop bytebase
   docker rm bytebase

2. 🚨 Back up the Bytebase metadata

   cp -rp ~/.bytebase/data ~/.bytebase/data.bak

   Above example backs up the metadata stored in the embedded database. If you store metadata in the external PostgreSQL, you should back up that database.

3. Change version string to 3.1.0

4. Start Bytebase

   docker run --rm --init \
     --name bytebase \
     --publish 8080:8080 --pull always \
     --volume ~/.bytebase/data:/var/opt/bytebase \
     bytebase/bytebase:3.1.0

Version Management#

Bytebase adopts Semantic Versioning using the MAJOR.MINOR.PATCH format.

Bytebase ties the version number with the underlying database schema progression, because:

1. Schema change is a good approximate to the functional change. Large schema changes often indicate large functional changes.

2. Schema change determines the customer involvement when upgrading to the new version.

   • MAJOR version change usually happens once a year. It might require manual effort from the customer. Bytebase will try to avoid that if possible.
   • MINOR version is changed when the underlying database schema changes. While the upgrade does not require customer involvement. MINOR version change usually happens about once every month.
   • PATCH version is changed when the new version does not include underlying database schema changes. PATCH version change usually happens bi-weekly following our release schedule.

Upgrade MINOR and PATCH version#

Just replace the version string and restart. Bytebase will self-upgrade automatically.

Upgrade from 1.x or 2.x#

Please first upgrade to 2.1.0 and then upgrade to the latest version.