Back
Outdated Version

You are viewing an older version of this section. View current production version.

SingleStore Tools Overview

SingleStore provides a suite of tools to manage, monitor, and interact with your cluster.

SingleStore DB Toolbox

For clusters running MemSQL 6.7 or later, you should use SingleStore DB Toolbox to deploy, administer, and manage your cluster. The associated tools are packaged in Debian, RPM, or tar files which allows them to be part of common automated deployment workflows.

Most of the tools are part of the singlestoredb-toolbox package; however, the lower-level management tool, memsqlctl, is part of the memsql-server package (along with the SingleStore DB engine itself).

For more information on the tools, see the following links:

  • sdb-toolbox-config. Performs host machine registration.

  • sdb-deploy. Installs memsqlctl and the SingleStore DB database engine to host machines in the cluster.

  • sdb-admin. Helps you manage a cluster.

  • sdb-report. Collects and performs diagnostic checks on your cluster.

  • memsqlctl. Provides lower-level access to manage nodes on a host machine.

Visualization and Application Tools

The following tools allow you to directly monitor and issue queries against your cluster, and as with the management tools above, they are packaged in Debian, RPM, or tar files for easy deployment and management:

  • SingleStore DB Studio. Provides a visual user interface that allows you to easily monitor, debug, and interact with all of your clusters. Available in the singlestoredb-studio package.

  • singlestore-client. A lightweight client application that allows you to connect to your cluster and run queries. Available in the singlestore-client package.

  • SingleStore Replicate. A data ingestion tool for replicating data from a source type (such as Oracle) into SingleStore DB. Filters and maps can be used to tailor how the data is replicated.

Managing your Tools

Because these new tools are available in Debian and RPM packages, you can use common package manager commands to perform basic operations such as installing, upgrading, and removing these packages and their associated files.

Examples of these package operations are shown below.

Online Installation

For online installations where you can access the SingleStore YUM repository, run the following steps.

Note: These steps are also provided in the self-managed SingleStore Tools deployment guides and the SingleStore DB Studio installation guide.

  1. 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

  2. Verify that the SingleStore repo information is listed under repolist.

    sudo yum repolist

  3. Verify you have 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, you must install it before proceeding. If you cannot install which, you will have to specify the correct package during the deployment phase covered in Deploy SingleStore DB.

    sudo yum install -y which

  4. To install the management tools, client application, and SingleStore DB Studio, run the following:

    sudo yum install -y singlestoredb-toolbox singlestore-client singlestoredb-studio

Offline Installation

For clusters that must be deployed in an environment without Internet access, download the following SingleStore packages onto a device with access to the main deployment machine.

memsql-server singlestoredb-toolbox singlestore-client singlestoredb-studio

For offline installations, you only need to copy and install singlestoredb-toolbox (and optionally singlestore-client and singlestoredb-studio) onto the main deployment machine as the sdb-deploy tool in singlestoredb-toolbox will be used to install the memsql-server package onto each host machine in your cluster.

sudo rpm -ivh /tmp/singlestoredb-toolbox-<version>.x86_64.rpm

sudo rpm -ivh /tmp/singlestore-client-<version>.x86_64.rpm

sudo rpm -ivh /tmp/singlestoredb-studio-<version>.x86_64.rpm

Upgrading your packages

To upgrade the tools in the singlestoredb-toolbox, singlestoredb-studio, or singlestore-client packages, follow the same basic steps that you would perform to update any RPM package.

Info

The memsql-server package should be updated through the sdb-deploy upgrade command. This command will install, update, and then restart nodes in your cluster (or rollback the installation process, if necessary).

Online

sudo yum update -y singlestoredb-toolbox

Offline

sudo rpm -Uvh /tmp/singlestoredb-toolbox-<version>.x86_64.rpm

Uninstalling SingleStore DB and removing the packages

If you want to completely uninstall SingleStore DB and its related tools packages, first uninstall SingleStore DB from your nodes by using the sdb-deploy uninstall command. This will remove the memsql-server package for that version of SingleStore DB (all versions of SingleStore DB can be uninstalled using the --all-versions flag).

As part of the removal process, or to simply remove any of the other SingleStore Tools packages, perform the following operation for each package you want to remove:

Info

The remove command and -e flag will only remove the binaries in the package and not remove any configuration files.

Online

sudo yum remove singlestoredb-toolbox

Offline

sudo rpm -e singlestoredb-toolbox

Online Installation

For online installations where you can access the SingleStore APT repository, run the following steps.

Note: These steps are also provided in the self-managed SingleStore Tools deployment guides and the SingleStore DB Studio installation guide.

  1. SingleStore packages are signed to ensure integrity, so the GPG key needs to be added to this machine. 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

  2. Verify you have apt-transport-https installed.

    apt-cache policy apt-transport-https

    If apt-transport-https is not installed, you must install it before proceding.

    sudo apt -y install apt-transport-https

  3. 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

  4. To install the management tools, client application, and SingleStore DB Studio, run the following:

    sudo apt update && sudo apt -y install singlestoredb-toolbox singlestore-client singlestoredb-studio

Offline Installation

For clusters that must be deployed in an environment without Internet access, download the following SingleStore packages onto a device with access to the main deployment machine.

memsql-server singlestoredb-toolbox singlestore-client singlestoredb-studio

For offline installations, you only need to copy and install singlestoredb-toolbox (and optionally singlestore-client and singlestoredb-studio) onto the main deployment machine as the sdb-deploy tool in singlestoredb-toolbox will be used to install the memsql-server package onto each host machine in your cluster.

sudo dpkg -i /tmp/singlestore-client_<version>_amd64.deb

sudo dpkg -i /tmp/singlestoredb-studio_<version>_amd64.deb

sudo dpkg -i /tmp/singlestoredb-toolbox_<version>_amd64.deb

Upgrading your packages

To upgrade the tools in the singlestoredb-toolbox, singlestoredb-studio, or singlestore-client packages, follow the same basic steps that you would perform to update any Debian package.

Info

The memsql-server package should be updated through the sdb-deploy upgrade command. This command will install, update, and then restart nodes in your cluster (or rollback the installation process, if necessary).

Online

sudo apt update && sudo apt install -y singlestoredb-toolbox

Offline

sudo dpkg -i /tmp/singlestoredb-toolbox_<version>_amd64.deb

Uninstalling SingleStore DB and removing the packages

If you want to completely uninstall SingleStore DB and its related tools packages, first uninstall SingleStore DB from your nodes by using the sdb-deploy uninstall command. This will remove the memsql-server package for that version of SingleStore DB (all versions of SingleStore DB can be uninstalled using the --all-versions flag).

As part of the removal process, or to simply remove any of the other SingleStore Tools packages, perform the following operation for each package you want to remove:

Info

The purge command and -P flag will remove the binaries in the package as well as any configuration files. If you want to keep the configuratino files, use the remove command or -r flag instead.

Online

sudo apt purge singlestoredb-toolbox

Offline

sudo dpkg -P /tmp/singlestoredb-toolbox_<version>_amd64.deb

Questions?

Ask the Community, find solutions in the Troubleshooting Overview, get Self-Paced Training or learn more about our Support Plans.