SingleStore Client Installation
Install SingleStore Client
Online Installation
For online installations where the target host can access the SingleStore YUM repository, perform the following steps.
Note: These steps are also provided in the self-managed deployment guides.
Add the SingleStore repository to your repository list.
sudo yum-config-manager --add-repo https://release.memsql.com/production/rpm/x86_64/repodata/memsql.repo
Verify that the SingleStore repo information is listed under
repolist
.sudo yum repolist
Verify that the
which
package installed. This is used during the install process to identify the correct package type for your installation.rpm -q which
If
which
is not installed, it must be installed before proceeding.If you cannot install
which
, you will have to specify the correct package during the deployment phase covered in the respective deployment guide.sudo yum install -y which
Install the SingleStore client.
sudo yum install -y singlestore-client
Offline Installation
For clusters that must be deployed in an environment without Internet access, download the SingleStore client package onto a host that can access the main deployment host.
Copy the SingleStore client package onto the target host (typically the main deployment host when deploying SingleStoreDB) and install the SingleStore client.
sudo rpm -ivh /tmp/singlestore-client-<version>-<commit-hash>.x86_64.rpm
Online Installation
For online installations where the target host can access the SingleStore APT repository, perform the following steps.
Note: These steps are also provided in the self-managed deployment guides.
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 list
Verify that
apt-transport-https
is installed.apt-cache policy apt-transport-https
If
apt-transport-https
is not installed, it must be installed before proceeding.user-shell sudo apt -y install apt-transport-https
Add the SingleStore repository to retrieve its packages.
echo "deb [arch=amd64] https://release.memsql.com/production/debian memsql main" | sudo tee /etc/apt/sources.list.d/memsql.list
Install the SingleStore client.
sudo apt update && sudo apt -y install singlestore-client
Offline Installation
For clusters that must be deployed in an environment without Internet access, download the SingleStore client package onto a host that can access the main deployment host.
Copy the SingleStore client package onto the target host (typically the main deployment host when deploying SingleStoreDB) and install the SingleStore client.
sudo dpkg -i /tmp/singlestore-client_<version>_<commit-hash>_amd64.deb
Download the SingleStore Client
Download the SingleStore client tarball file onto a host that can access the main deployment host.
Transfer the SingleStore Client
Transfer the SingleStore client tarball file into a dedicated singlestore
directory on the target host (typically the main deployment host when deploying SingleStoreDB) that has been configured so that non-sudo
users can access it, such as /home/<user>/singlestore
or /opt/singlestore
.
Unpack the SingleStore Client
Unpack the SingleStore client tarball file into the singlestore
directory.
tar xzvf singlestore-client-<version>-<commit-hash>.x86_64.tar.gz
Using symbolic links (or "symlinks") can make using and upgrading the SingleStore client easier. Performing the following steps will allow the singlestore
command to be run from anywhere on the filesystem, even after an upgrade by updating the symlink.
Navigate to the directory that contains the unpacked SingleStore client tarball file and create a
singlestore-client
symlink that points to the SingleStore client directory.ln -s singlestore-client-<version>-<commit-hash> singlestore-client
Verify that the symlink has been created.
ls -l **** singlestore-client -> singlestore-client-1.0.6-c3803db03b
Update the
PATH
environment variable with the path to the newsinglestore-client
directory. This path can also be added to your shell startup file so you won't have to run this command each time you log in.export PATH=/home/<user>/singlestore/singlestore-client:$PATH
You may now run the
singlestore
command from anywhere on the filesystem.singlestore
Upgrade SingleStore Client
To upgrade the SingleStore client, use the same steps for upgrading any RPM package.
Online
sudo yum update -y singlestore-client
Offline
Download the SingleStore client package.
Upgrade the SingleStore client.
sudo rpm -Uvh /tmp/singlestore-client-<version>-<commit-hash>.x86_64.rpm
To upgrade the SingleStore client, use the sane steps for upgrading any Debian package.
Online
sudo apt update && sudo apt install -y singlestore-client
Offline
Download the SingleStore client package.
Upgrade the SingleStore client.
sudo dpkg -i /tmp/singlestore-client_<version>_<commit-hash>_amd64.deb
To upgrade the SingleStore client, you must manually replace the existing SingleStore client with a new one.
Obtain the latest version of the SingleStore client.
curl https://release.memsql.com/production/index/memsqlclient/latest.json
The JSON returned contains a relative path to the
singlestore-client-tar
file in the following format."Path": "production/tar/x86_64/singlestore-client-<version>-<commit-hash>.x86_64.tar.gz"
Use
wget
to download the file by copying, pasting, and appending the path to https://release.memsql.com/. For example:wget https://release.memsql.com/production/tar/x86_64/singlestore-client-<version>-<commit-hash>.x86_64.tar.gz
As an alternative, you may download the latest version of the SingleStore client tarball file using the following link.
Transfer the SingleStore client tarball file to the main deployment host where the existing SingleStore client has been installed.
Unpack the SingleStore client tarball file. This directory will now contain two versions of the SingleStore client: the existing version, and the new version.
tar xzvf singlestore-client-<version>-<commit-hash>.x86_64.tar.gz
Using symbolic links (or "symlinks") can make using and upgrading the SingleStore client easier. Performing the following steps will allow the singlestore
command to be run from anywhere on the filesystem, even after an upgrade.
Check if a
singlestore-client
symlink already exists within the current directory.ls -l
If so, remove the existing
singlestore-client
symlink.rm singlestore-client
Create a
singlestore-client
symlink by pointing it to the new version of the SingleStore client directory.ln -s singlestore-client-<version>-<commit-hash> singlestore-client
Verify that the symlink has been created.
ls -l **** singlestore-client -> singlestore-client-1.0.6-c3803db03b
Update the
PATH
environment variable with the path to the newsinglestore-client
directory. This path can also be added to your shell startup file so you won't have to run this command each time you log in.export PATH=/home/<user>/singlestore/singlestore-client:$PATH
You may now run the
singlestore
command from anywhere on the filesystem.singlestore
The upgrade is now complete.
Should you encounter any issues with the new SingleStore client, you can simply point the singlestore-client
symlink back to the previous version.
After validating that the new version of the SingleStore client is working as expected, you may remove the previous version.
rm -rf singlestore-client-<version>-<commit-hash>
Uninstall SingleStore Client
You may either uninstall the SingleStore client individually or remove it while uninstalling SingleStoreDB. If you want to completely uninstall SingleStoreDB and its related Tools packages, first uninstall SingleStoreDB from your nodes by using the sdb-deploy uninstall
command. This will remove the singlestoredb-server
package for that version of SingleStoreDB. To uninstall all versions of SingleStoreDB, include the --all-versions
flag.
Important
The remove
command and -e
flag will only remove the binaries in the package and not remove any configuration files.
Run the following command to uninstall the SingleStore client.
Online
sudo yum remove singlestore-client
Offline
sudo rpm -e singlestore-client
You may either uninstall the SingleStore client individually or remove it while uninstalling SingleStoreDB. If you want to completely uninstall SingleStoreDB and its related Tools packages, first uninstall SingleStoreDB from your nodes by using the sdb-deploy uninstall
command. This will remove the singlestoredb-server
package for that version of SingleStoreDB. To uninstall all versions of SingleStoreDB, include the --all-versions
flag).
Run the following command to uninstall the SingleStore client.
Important
The purge
command and -P
flag will remove the binaries in the package as well as any configuration files.
To keep the configuration files, use the remove
command or -r
flag instead.
Online
sudo apt purge singlestore-client
Offline
sudo dpkg -P /tmp/singlestore-client_<version>_<commit-hash>_amd64.deb
Run the following commands to uninstall the SingleStore client.
Change to the directory where the SingleStore client has been installed.
cd /home/<user>/singlestore
Remove the SingleStore client directory (or directories, if more than one version has been installed).
rm -rf singlestore-client-<version>-<commit-hash>