upgrade

Description

Upgrade the version of singlestoredb-server for an entire cluster.

Usage

Usage:
sdb-deploy upgrade [flags]
For flags that can accept multiple values (indicated by VALUES after the name of the flag),
separate each value with a comma.
Flags:
--disable-auto-restart Disable automatic restart of memsqld on error
--file-path ABSOLUTE_PATH The singlestoredb-server package to install
--force-package-format {deb, rpm, tar} Specify 'deb', 'rpm', or 'tar' package format. Required if you have both dpkg and rpm package managers found on the host
-h, --help Help for upgrade
--online Indicate whether an online upgrade should be performed. This requires High Availability to be enabled on the cluster. SingleStore will be operational during the upgrade
--precheck-only Check if the cluster is stable and an upgrade is possible but do not perform an upgrade
--preinstalled-path ABSOLUTE_PATH The path to the folder (must be of the form 'singlestoredb-server-<version>*' or 'memsql-server-<version>*') that contains the singlestoredb-server binaries.
Depending on the mode of cluster deployment, the folder contains either the unpacked tarball file or the installed package file (Debian or RPM) of singlestoredb-server. (ADVANCED)
--set-configs key=value Set configuration variables during upgrade. Only those variables that can be set on startup are permitted. For example: --set-configs strict_mode=1,auditlog_level=ALL-QUERIES (ADVANCED)
--skip-system-warnings Skip warnings about system configurations and limits
--skip-uninstall memsql-server Do not remove the prior memsql-server/`singlestorerdb-server` version package after a successful upgrade
--skip-version-check Do not compare the version to be installed with the currently running singlestoredb-server version.
Upgrading with this flag enabled may lead to an inoperative cluster and unrecoverable data
--temp-dir ABSOLUTE_PATH The directory on the local and remote host(s) to store temporary files during upgrade (ADVANCED)
--upgrade-to-latest-patch Upgrade to the latest patch version of the current SingleStore version
--version VERSION The version of singlestoredb-server to install (default production:latest)
Global Flags:
--backup-cache FILE_PATH File path for the backup cache
--cache-file FILE_PATH File path for the Toolbox node cache
-c, --config FILE_PATH File path for the Toolbox configuration
--disable-colors Disable color output in console, which some terminal sessions/environments may have difficulty with
--disable-spinner Disable the progress spinner, which some terminal sessions/environments may have issues with
-j, --json Enable JSON output
--parallelism POSITIVE_INTEGER Maximum number of operations to run in parallel
--runtime-dir DIRECTORY_PATH Where to store Toolbox runtime data
--ssh-max-sessions POSITIVE_INTEGER Maximum number of SSH sessions to open per host, must be at least 3
--ssh-strict-host-key-checking Enable strict host key checking for SSH connections
--ssh-user-known-hosts-file FILE_PATH Path to the user known_hosts file for SSH connections. If not set, /dev/null will be used
--state-file FILE_PATH Toolbox state file path
-v, --verbosity count Increase logging verbosity: valid values are 1, 2, 3. Usage -v=count or --verbosity=count
-y, --yes Enable non-interactive mode and assume the user would like to move forward with the proposed actions by default

Remarks

This command is interactive unless you use either --yes or --json flag to override interactive behavior.

Last modified: January 25, 2024

Was this article helpful?