SingleStoreDB Studio Upgrade

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.6, see Upgrade to SingleStoreDB 7.6.

Red Hat Distribution

To update the singlestoredb-studio package with YUM, run the following:

sudo yum update singlestoredb-studio

Set Up SingleStoreDB Studio

Start Studio

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

Package-based Installation

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. Use nohup to prevent singlestoredb-studio from terminating when you close your terminal session.

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

SSH into your main deployment host and perform the following:

  1. Change to the singlestoredb-studio-<version> directory where you unpacked Studio.

    cd singlestoredb-studio-<version>
  2. Start Studio from the command line. Use nohup to prevent singlestoredb-studio from terminating when you close your terminal session.

    nohup ./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.

Debian Distribution

  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. 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
  3. Update the singlestoredb-studio package.

    sudo apt install singlestoredb-studio

Set Up SingleStoreDB Studio

Start Studio

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

Package-based Installation

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. Use nohup to prevent singlestoredb-studio from terminating when you close your terminal session.

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

SSH into your main deployment host and perform the following:

  1. Change to the singlestoredb-studio-<version> directory where you unpacked Studio.

    cd singlestoredb-studio-<version>
  2. Start Studio from the command line. Use nohup to prevent singlestoredb-studio from terminating when you close your terminal session.

    nohup ./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.

Last modified: July 24, 2023

Was this article helpful?