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

SingleStore DB Studio Installation Guide

Info

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

Installing SingleStore DB 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.

Info

You can also see how to install Studio as part of an overall deployment in the on-premises installation guides.

Online Installation

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

  1. Add the MemSQL 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 MemSQL repo information is listed under repolist.

    sudo yum repolist
    
  3. Install SingleStore DB 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 MemSQL APT repository, run the following steps.

  1. MemSQL packages are signed to ensure integrity, so the GPG key needs to be added to this machine. When done, verify that the MemSQL 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 MemSQL 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 MemSQL repo information is listed in the output, install SingleStore DB 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

Start SingleStore DB 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 SingleStore DB Studio service to start SingleStore DB 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 SingleStore DB Studio directly.

sudo singlestoredb-studio &

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

Add A New Cluster to SingleStore DB Studio

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

    Info

    SingleStore DB 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.