SingleStoreDB Studio Installation

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.

   Shell

   Copy

   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.

   Shell

   Copy

   sudo yum repolist

3. Install Studio.

   Shell

   Copy

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

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 host. When done, verify that the SingleStore signing key has been added using apt-key list.

   Shell

   Copy

   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.

   Shell

   Copy

   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.

   Shell

   Copy

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

   Shell

   Copy

   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 Studio

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

sudo systemctl start singlestoredb-studio

sudo systemctl enable singlestoredb-studio.service

Created symlink /etc/systemd/system/multi-user.target.wants/memsql-studio.service → /lib/systemd/system/memsql-studio.service.

nohup sudo singlestoredb-studio > studio.stdout 2> studio.stderr < /dev/null &

Add a New Cluster to Studio

1. With Studio running, go to http://localhost:8080 on your local host 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 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.