You are viewing an older version of this section. View current production version.
Join the SingleStore Community Today
Get expert advice, develop skills, and connect with others.

MemSQL Studio Architecture

Info

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

MemSQL Studio has a one-to-many relationship with MemSQL clusters, which provides a number of advantages:

  • Easy upgrades: MemSQL Studio can be upgraded in minutes, making it easy to stay up to date with the latest features.

  • Multi-cluster management in one UI: A single instance of MemSQL Studio can communicate with all of your MemSQL clusters.

  • Easily scalable: As multiple MemSQL Studio instances can communicate with an individual MemSQL cluster, you can easily scale out MemSQL Studio by creating new instances to manage user load.

MemSQL Studio Directory Layout

For installations using the MemSQL Studio RPM and Debian packages, MemSQL Studio follows the Linux Standard Base (LSB) layout.

Alternatively, MemSQL Studio can be installed via tarball and within a single directory.

RPM and Debian Package Installation

A MemSQL Studio RPM and Debian package-based installation creates files in the following directories:

/
   etc/
	   memsql/
		   memsql-studio.hcl
   var/
	   log/
		   memsql-studio/
			   memsql-studio.log
			   memsql-studio.2017-11-09T10:23:03-08:00.log.gz
	   lib/
		   memsql-studio/
			   studio.hcl
   usr/
	   bin/
		   memsql-studio

Single-Directory Installation

For installations using a tarball or single-directory installation, the layout is as follows:

path/to/memsql-clients-{VERSION}/
	memsql-studio.hcl
	memsql-studio

memsql-studio-logs/
	memsql-studio.log
	memsql-studio.2017-11-09T10:23:03-08:00.log.gz

state/
	studio.hcl

State File

The MemSQL Studio state file is a text file that is used for storing the list of clusters known to MemSQL Studio.

For RPM and Debian-based installations, this file is located in /var/lib/memsql-studio/studio.hcl.

For tarball-based installations, this file is located in state/studio.hcl.

An example state file:

version = 1

cluster "2d76801f-4b4a-4679-82b9-12d0b3cda30a" {
  name        = "my cluster"
  description = "data science cluster"
  hostname    = "85.88.53.151"
  port        = 3306
  profile     = "DEVELOPMENT"
}

Configuration File

The MemSQL Studio configuration file is a text file that is responsible for configuring various aspects of MemSQL Studio. It is read each time MemSQL Studio is started.

For RPM and Debian-based installations, this file is located in /etc/memsql/memsql-studio.hcl.

For tarball-based installations, this file is located in path/to/memsql-clients-{VERSION}/memsql-studio.hcl.

An example configuration file:

# This is the IP address that MemSQL Studio will bind to.
host = "0.0.0.0"

# This is the port that MemSQL Studio will bind to.
port = 8080

# This is the path to the state file of MemSQL Studio.
statePath = "/var/lib/memsql-studio/studio.hcl"

# This is the path to the log file of MemSQL Studio.
logPath = "/var/lib/memsql-studio/studio.log"
Info

Notice that the location of the state file can be specified in the configuration file.