Set Up SingleStore DB Studio min read


SingleStore DB Studio allows you to easily monitor, debug, and interact with all of your SingleStore DB clusters. This step shows you how to set up Studio on an existing host in your cluster.

Info

Stand-alone installation and usage instructions for SingleStore DB Studio can also be found here.

Start SingleStore DB Studio

Info

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

sudo Users

SSH into your main deployment host and run the following:

sudo systemctl start singlestoredb-studio

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

sudo singlestoredb-studio &

Non-sudo Users

SSH into your main deployment host and perform the following:

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

    cd singlestoredb-studio-<version>
    
  2. Start SingleStore DB 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 SingleStore DB Studio

  1. With SingleStore DB Studio running, go to http://<main_deployment_host>:8080 and click Add New Cluster to set up a cluster.

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

  2. Paste the main deployment host IP address into Hostname.

  3. Set Port to 3306.

  4. Specify root as the Username and leave Password empty.

  5. Click Create Cluster Profile and set Type as Development.

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