Upgrade SingleStoreDB
On this page
Note
SingleStoreDB betas and release candidates cannot be upgraded unless explicitly stated in the release notes.
SingleStoreDB cannot be upgraded via tarball if it was initially installed/deployed using a package manager and vice versa.
Upgrade Paths
Here are the version requirements for upgrading SingleStoreDB:
Upgrade to. |
Version Requirements |
---|---|
Version 7. |
Upgrading from version 7. Upgrading directly from version 6. |
Version 7. |
Must upgrade from version 6. Online upgrade from version 7. Online upgrade from version 6. Offline upgrade is supported from version 6. |
Warning
Critical cluster operations such as an upgrade should be not interrupted.
If an SSH connection to a server is interrupted or lost during an upgrade, it can leave a cluster in a non-standard state.
Therefore, it is recommended to use terminal multiplexers such as tmux
or screen
to run an upgrade session.
Upgrade Your Cluster
Select an option below to upgrade your cluster.
Step 1: Upgrade SingleStore Toolbox
To upgrade your existing SingleStoreDB cluster, SingleStore recommends upgrading Toolbox to 1.
Run the install
command to either install singlestoredb-toolbox
if it is not already installed, or upgrade an existing version of Toolbox to the latest version of the package.
Red Hat
sudo yum install singlestoredb-toolbox -y
Debian
-
SingleStore packages are signed to ensure integrity, so the GPG key needs to be added to this host.
When done, verify that the SingleStore signing key has been added using apt-key list
.wget -O - 'https://release.memsql.com/release-aug2018.gpg' 2>/dev/null | sudo apt-key add - && apt-key listWithout using
apt-key
:wget -q -O - 'https://release.memsql.com/release-aug2018.gpg' | sudo tee /etc/apt/trusted.gpg.d/memsql.asc 1>/dev/null -
Upgrade Toolbox.
sudo apt install singlestoredb-toolbox -y
Upgrade without Internet access
If your cluster does not have internet access, use one of the following buttons to download either the latest RPM or Debian singlestoredb-toolbox
package to a location accessible by your cluster:
Then, run the install
command for the installed package manager and specify the path to the package.
Red Hat
sudo yum install /path/to/singlestoredb-toolbox.rpm -y
Debian
sudo apt install /path/to/singlestoredb-toolbox.deb -y
Now you are ready to upgrade SingleStoreDB.
Step 2: Upgrade SingleStoreDB
The simplest and preferred upgrade option is an offline cluster upgrade.
If the cluster is running with High Availability, you also have the option to perform an incremental online cluster upgrade, which maintains cluster availability throughout the upgrade process.
Prior to upgrading your cluster, it is recommended that you take a backup as a standard precautionary measure.
Option 1: Offline Upgrade
Note: Using this method to upgrade SingleStoreDB is referred to as an offline
upgrade as your SingleStoreDB cluster will be shut down and restarted over the course of the upgrade.
Execute the following command to start an offline upgrade.
-
Confirm that the cluster can be upgraded.
The cluster will not be upgraded when running this command. sdb-deploy upgrade --precheck-only -
Upgrade your cluster.
Note:
sdb-deploy upgrade
will perform a snapshot of all databases prior to upgrade.sdb-deploy upgrade --version 7.3
If you do not specify a patch version, your cluster will be upgraded to the latest patch release of the SingleStoreDB version specified.
Note: You cannot downgrade from your current version.
If your cluster does not have internet access, use one of the following buttons to download either the latest RPM or Debian singlestoredb-server
package to a location accessible by your cluster:
The singlestoredb-server
package contains both the SingleStoreDB binary and the low-level management tool, memsqlctl
.
Run the sdb-deploy upgrade
command and reference the appropriate package in the --file-path
argument.upgrade
(as opposed to simply upgrading the package via the package manager) will perform an offline restart of all the nodes to make sure the cluster is using the new version.
Red Hat
sdb-deploy upgrade --file-path /path/to/singlestoredb-server.rpm
Debian
sdb-deploy upgrade --file-path /path/to/singlestoredb-server.deb
Refer to sdb-deploy upgrade for more information.
Option 2: Online Upgrade
This upgrade method is referred to as an online
upgrade as your SingleStoreDB cluster will not be shut down over the course of the upgrade.
Note
An online upgrade may fail if a long-running workload that writes to the database, or a workload that manipulates SingleStoreDB files (such as an automated backup or maintenance script), is running on the target cluster.
Toolbox 1.
Execute the following command to start an online upgrade.
-
Confirm that the cluster can be upgraded.
The cluster will not be upgraded when running this command. sdb-deploy upgrade --precheck-only -
Upgrade your cluster.
Note:
sdb-deploy upgrade
will perform a snapshot of all databases prior to upgrade.sdb-deploy upgrade --online --version 7.3
By specifying --version
, your cluster will be upgraded to the latest patch version of the SingleStoreDB version specified.
Note: You cannot downgrade from your current version.
If your cluster does not have internet access, use one of the following buttons to download either the latest RPM or Debian singlestoredb-server
package to a location accessible by your cluster:
The singlestoredb-server
package contains both the SingleStoreDB binary and the low-level management tool, memsqlctl
.
Run the sdb-deploy upgrade --online
command and reference the appropriate package in the --file-path
argument.upgrade
(as opposed to simply upgrading the package via the package manager) will perform an offline restart of all the nodes to make sure the cluster is using the new version.
Red Hat
sdb-deploy upgrade --online --file-path /path/to/singlestoredb-server.rpm
Debian
sdb-deploy upgrade --online --file-path /path/to/singlestoredb-server.deb
Refer to sdb-deploy upgrade for more information.
Roll Back from a Failed Upgrade
Currently, SingleStoreDB does not support downgrading directly.
Note that a backup created from a given version of the SingleStoreDB engine can only be restored to the same engine version or later.
-
Make a backup of the cluster configuration.
sdb-deploy generate-cluster-file -
Delete all of the nodes in the cluster.
sdb-admin delete-node --stop --all -
Use the following command to roll back to an earlier version of the SingleStoreDB engine by removing the engine version(s) you do not want.
For example, if upgrading to SingleStoreDB 8.
0 fails, remove 8. 0. sdb-deploy uninstall --version 8.0 -
Unregister all hosts in the cluster.
sdb-toolbox-config unregister-host --all -
Recreate the cluster using the cluster configuration captured in the cluster file.
Note that the cluster file may contain the engine version, so be sure to update the cluster file with the engine version you wish to restore. sdb-deploy setup-cluster --cluster-file /path/to/cluster/file -
Restore the cluster's data from the backup that was made earlier.
Refer to Backing Up and Restoring Data for more information.
Step 1: Upgrade MemSQL Ops
To upgrade your existing SingleStoreDB cluster, SingleStore recommends upgrading to the latest version of MemSQL Ops before upgrading SingleStoreDB.
If you are running Ops 6.agent-upgrade
command.
memsql-ops agent-upgrade
Upgrade without Internet Access
If your cluster does not have internet access, download the 7.agent-upgrade
command using the --file-path
argument.
sudo memsql-ops agent-upgrade --file-path /path/to/memsql-ops-XYZ.tar.gz
Now you are ready to upgrade SingleStoreDB.
Step 2: Upgrade SingleStoreDB
The currently supported upgrade option is an offline cluster upgrade.
Offline Upgrade
Note: Upgrading to SingleStoreDB is referred to as an offline
upgrade as your SingleStoreDB cluster will be shut down and restarted over the course of the upgrade.
Execute the following command to start an offline upgrade.
memsql-ops memsql-upgrade --version 7.3
If you do not specify a patch version, your cluster will be upgraded to the latest patch release of the SingleStoreDB version specified.
Note: You cannot downgrade from your current version.
If your cluster does not have internet access, download the SingleStoreDB binary from the following locations before running the memsql-upgrade
command with the --file-path
argument:
-
For the latest version, the download link is:
http://download.
memsql. com/releases/latest/memsqlbin_ amd64. tar. gz -
For any other version, the download link format is:
http://download.
memsql. com/releases/version/X. Y. Z/memsqlbin_ amd64. tar. gz
sudo memsql-ops memsql-upgrade --file-path /path/to/memsqlbin_amd64.tar.gz
Refer to MEMSQL-UPGRADE for more information.
Last modified: November 2, 2023