Skip to content
Developer Edition runs on one host and does not require a product license file. Need multi-host deployment or performance testing at scale? Explore Enterprise Edition

Upgrade NebulaGraph Studio

Upgrade NebulaGraph Studio with the method used for its current installation. Use the same method as your current installation, and back up the configuration and data first. The v5.3.2 packages are on GitHub Releases.

Caution

A new version may upgrade the database schema. Check that your backup is usable before upgrading. Switching back to an older program version might not restore the database.

Docker Compose

  1. Back up studio-compose.yaml in the deployment directory and the Docker studio-data volume. If you mounted config-release.yaml, back up that file too. If you use MySQL, back up that database separately.
  2. Check the target version's tag on Docker Hub, then set the studio service's image in studio-compose.yaml to vesoft/nebula-studio:<version>.

  3. In the deployment directory, run:

    docker compose -f studio-compose.yaml pull studio
docker compose -f studio-compose.yaml up -d
docker compose -f studio-compose.yaml ps

  4. Open NebulaGraph Studio and verify its configuration and data.

TAR package

  1. Enter the old installation directory and stop the service:

    sudo ./scripts/studio.service stop all
sudo ./scripts/studio.service status all

  2. Back up the old installation directory. With SQLite, back up data/studio.db and any studio.db-wal and studio.db-shm files in the same directory. With MySQL, back up that database separately.

  3. Download the TAR package for your operating system and architecture from the target version's release page. Extract it into a new directory; do not overwrite the old installation.
  4. Compare etc/config.yaml in both versions and apply your custom settings to the new file. With SQLite, copy the backed-up database files to the matching location in the new installation directory.
  5. Enter the new installation directory, start the service, and check its status:
    sudo ./scripts/studio.service start all
sudo ./scripts/studio.service status all

Remove the old installation directory only after verifying that the page and data work.

RPM or DEB package

  1. Stop the service. Back up /etc/nebula-studio/config.yaml and, if used, /etc/nebula-studio/studio.env. With the default SQLite setup, back up /var/lib/nebula-studio, including studio.db and any studio.db-wal or studio.db-shm files. With MySQL, back up the MySQL database separately.

    sudo systemctl stop nebula-studio.service

  2. Download the package for your operating system and architecture from the target version's release page. For RPM, run sudo rpm -Uvh <downloaded-RPM-file>. For DEB, run sudo dpkg -i <downloaded-DEB-file>.

  3. Check your custom settings in /etc/nebula-studio/config.yaml, then start and check the service:

    sudo systemctl start nebula-studio.service
sudo systemctl status nebula-studio.service

  4. Open NebulaGraph Studio and verify its configuration and data.