Skip to main content

SingleStoreDB Studio Installation

Install SingleStoreDB Studio

Caution

Studio should be installed on a host that is open to local (internal) network traffic only, and not open to the Internet.

Important

Studio is designed to work with MemSQL 6.5 or later and is only supported on Chrome and Firefox browsers at this time.

Installing Studio can be done easily through the popular package managers on Debian and Red Hat-based distributions. This allows you to utilize existing workflows when installing and upgrading your Studio package.

Important

You can also see how to install Studio as part of an overall deployment in the self-managed deployment guides.

Online Installation

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

  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. Install Studio.

    sudo yum install -y singlestoredb-studio
    

Offline Installation

For installation in an environment without Internet access, download the following singlestoredb-studio package and install it onto your target machine.

singlestoredb-studio

Install the singlestoredb-studio package using rpm.

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

Online Installation

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

  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 proceeding. user-shell 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. After verifying the SingleStore repo information is listed in the output, install Studio.

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

Offline Installation

For installation in an environment without Internet access, download the following singlestoredb-studio package and install it onto your target machine.

singlestoredb-studio

Install the singlestoredb-studio package using dpkg.

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

Download SingleStoreDB Files

Download the following SingleStore tarball file onto a device with access to the main deployment host.

singlestoredb-studio

Transfer SingleStoreDB Files

Transfer the singlestoredb-studio tarball file into a dedicated singlestore directory that has been configured so that non-sudo users can access on the main deployment host, such as /home/<user>/singlestore or /opt/singlestore.

Unpack SingleStoreDB Files

Note: For the remainder of this document, <version>-<commit-hash> will be written simply as <version>.

Unpack singlestoredb-studio into the singlestore directory.

tar xzvf singlestoredb-studio-<version>.tar.gz 

Set up SingleStoreDB Studio

Start Studio

Now that you have Studio installed, start the singlestoredb-studio systemd service using the systemctl start command.

sudo systemctl start singlestoredb-studio

Recommended: Enable the Studio service to start Studio at system boot.

sudo systemctl enable singlestoredb-studio.service
****
Created symlink /etc/systemd/system/multi-user.target.wants/memsql-studio.service → /lib/systemd/system/memsql-studio.service.

If your Linux distribution does not use systemd, you can run Studio directly.

sudo singlestoredb-studio &

Studio will now run the Studio web server on port 8080.

Add a New Cluster to Studio

  1. With Studio running, go to http://localhost:8080 on your local machine and click Add New Cluster to setup a cluster.

    Important

    Studio is only supported on Chrome and Firefox browsers at this time.

    To run Studio on a different port, add port = <port_name> to /etc/singlestore/singlestoredb-studio.hcl and restart Studio.

  2. Paste the Master Aggregator host machine IP address into Hostname.

  3. Set Port to the master aggregator database port for your cluster. The default is 3306.

  4. Specify a valid database user in Username.

  5. Enter the Password for your database user.

  6. Click Create Cluster Profile and set Type to describe your cluster: Development, Staging, or Production.

  7. Fill in Cluster Name and Description to your preference.

After you have successfully logged in, you will see the dashboard for your cluster. To run a query against your cluster, navigate to the SQL Editor through the navigation in the left pane.

Upgrade SingleStoreDB Studio

Important

Studio is designed to work with MemSQL 6.5 or later and is only supported on Chrome and Firefox browsers at this time.

Upgrading Studio can be done through the package manager on the computer, instance, or container where Studio is installed.

Important

Note that upgrading Studio does not automatically upgrade the database engine. To upgrade the database engine, see Upgrade SingleStoreDB.

To upgrade the database engine to version 7.3, see Upgrade to SingleStoreDB 7.3.

To upgrade the singlestoredb-studio package, follow the same basic steps that you would perform to update any RPM package.

Online

sudo yum update singlestoredb-studio

Offline

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

If you’re running singlestoredb-studio as a systemd service, it will be automatically restarted after you install the new version. However, if you’re running singlestoredb-studio directly, you have to restart the server after installing the new version of the package.

To upgrade the singlestoredb-studio package, follow the same basic steps that you would perform to update any Debian package.

Online

  1. To update the singlestoredb-studio package with APT, update the package lists for packages that need upgrading, as well as new packages that have just come to the repositories.

    sudo apt update
  2. Update the singlestoredb-studio package.

    sudo apt install singlestoredb-studio

Offline

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

If you’re running singlestoredb-studio as a systemd service, it will be automatically restarted after you install the new version. However, if you’re running singlestoredb-studio directly, you have to restart the server after installing the new version of the package.

To upgrade the Studio tarball, you need to replace the currently installed Studio binaries with new binaries. Using symbolic links is one way to achieve this action and the instructions are as follows.

  1. Navigate to the directory that contains the unpacked Studio tarball and create a symbolic link pointing to the Studio currently installed. Name this symlink singlestoredb-studio.

    ln -s singlestoredb-studio-<version>-<commit-hash> singlestoredb-studio

    Run ls -l to verify that the symlink is created.

  2. Obtain the latest version of singlestoredb-studio using the following command.

    curl https://release.memsql.com/production/index/memsqlstudio/latest.json

    The JSON you receive contains a relative path to the memsql-studio-tar file in the following format.

    "Path": "production/tar/x86_64/singlestoredb-studio-<version>-<commit-hash>.x86_64.tar.gz"
  3. Use wget to download the file by copying, pasting, and appending the path (minus the quotes) to https://release.memsql.com/. Example is shown below.

    wget https://release.memsql.com/production/tar/x86_64/singlestoredb-studio-<version>-<commit-hash>.x86_64.tar.gz

    As an alternative to steps 2 and 3, you can download the latest version of Studio tarball file using the following link.

    singlestoredb-studio

  4. Transfer the tarball file to the main deployment host where the earlier version of Studio is available.

  5. Unpack the Studio file by running the following command.

    tar xzvf singlestoredb-studio-<version>-<commit-hash>.tar.gz

    Now the directory contains both versions of Studio.

  6. Remove the singlestoredb-studio symlink by running the following command.

    rm singlestoredb-studio
  7. Recreate the symlink by pointing it to the new version of Studio downloaded and unpacked in steps 2 and 4.

    ln -s singlestoredb-studio-<version>-<commit-hash>/ singlestoredb-studio

    The upgrade is complete. If you encounter any issues and need to downgrade, you can simply point the symlink back to the old version for Studio.

  8. After successful validation, you can remove the old version of Studio by running the following command.

    rm -rf singlestoredb-studio-<version>-<commit-hash>

Note

Using symbolic links is optional in the Studio tarball upgrade. To perform the upgrade, you need to replace the old Studio binaries with new binaries with or without symbolic links.

As an alternative to using symbolic links for the upgrade, you can update the PATH environment variable with the path to the folder where the new version of Studio tarball is unpacked, as shown below.

export PATH=<Folder-with-new-binaries>/singlestoredb-studio-<version>-<commit-hash>/:$PATH

Uninstall SingleStoreDB Studio

You can either uninstall Studio as a standalone task 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 (all versions of SingleStoreDB can be uninstalled using 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.

As part of the removal process, or to simply remove Studio, perform the following operation:

Online

sudo yum remove singlestoredb-studio

Offline

sudo rpm -e singlestoredb-studio

You can either uninstall Studio as a standalone task 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 (all versions of SingleStoreDB can be uninstalled using the --all-versions flag).

As part of the removal process, or to simply remove Studio, perform the following operation:

Important

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 configuration files, use the remove command or -r flag instead.

Online

sudo apt purge singlestoredb-studio

Offline

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