Installing s-Studio and Client Tools as Standalone Packages

While both SQLstream s-Studio and SQLstream client tools install as part of the s-Server suite, you may also want to install them on a machine that connects to s-Server. s-Studio lets you monitor and manipulate s-Server data, while client tools provide a range of functionality, from collecting data on a remote server (say, one with a log file) to generating test data, to running SQL against s-Server in a terminal (sqlLine client).

Installing SQLstream Client Tools

The SQLstream Client Tools are a set of applications that assist you in running, testing, and maintaining your s-Server.  By default, Client Tools install as part of the s-Server package. These instructions are for installing Client Tools in a standalone context.

You can run any of the client tools below as a regular user. Most of them use JDBC to connect with s-Server.

The following client tools install on both Linux and Windows:

Client Tool Description Disk Space
SQLline SQLLine is a command-line tool for communicating with the SQLstream s-Server. It is a generic & open-source database client that works with any jdbc database. More information about SQLLine can be found at http://sqlline.sourceforge.net/ 11 KB
datagen Datagen generates test data for SQLstream applications, and pushes the data into SQLstream using the SQLstream JDBC Driver. 1 MB
jdbc JDBC (Java DataBase Connectivity) is a standard Java API for connecting to relational databases and other data sources that can produce relational data. 2 MB
ECD Agent The ECD Agent is a standalone Java application that mediates data between - SQLstream s-Server and external data sources. It can be installed on a remote server in order to process or parse data at the site of collection. For example, if you have a server which generates log files, you may find it advantageous to have the ECDA Agent parse those files on the server itself, and pass rows to s-Server, as opposed to passing the entire file. 60 MB
WebAgent WebAgent functions as a simple, miniature Web server. It accepts HTTP requests, sends these to s-Server, and returns JSON objects. See json.org for more details on JSON objects. 11 MB
Google Big Query Connector SQLstream Google Big Query Connector is a bulk load script that lets you load s-Server data into Google Big Query. 17 MB

Installation Notes for Linux

From a terminal prompt enter ./SQLstream-clienttools-X.Y.Z-x64.run, where X.Y.Z represent the release and version numbers, as in SQLstream-, and x64* or x32* represents running on a 64-bit or 32-bit operating system.

  • If it does not work, make sure the file is executable (by running chmod +x SQLstream-sStudio-X.Y.Z-x64.run), and try double-clicking the SQLstream icon again.
  • If the installer still does not launch, it generally means JAVA_HOME is not in the default PATH, so the installer fails to find/run Java to execute the installer. Ensure that JAVA_HOME is in the default PATH and try double-clicking the icon again.

Client tools are all pure Java, so they should run on any system that has a Java Runtime Environment (JRE) or Java Development Kit (JDK) installed. Moreover, the 32-bit Linux installer (SQLstream-client-tools-x.y.z-linux.run) should generally run on any Linux system. However, some 64-bit Linux systems are not properly configured to handle 32-bit applications. If you run the 32-bit installer and nothing happens, this may be the case for your system. In this case, you can use the 64-bit installer (SQLstream-client-tools--linux-x64.run) to install the same client tools.

Installation Notes for Windows

To install Client Tools on Windows, launch SQLstream-client-tools--windows.exe. Before installing client tools on Windows, you need to make sure Java is installed and in the installing user's path.

Installation Process

After you launch the installer on either platform, a welcome page appears.

  1. Click Forward. The SQLstream License Agreement page appears. Click I accept the agreement.
  2. Click Forward. The Installation Directory page appears. This page lets you select directories for the client tools. Note: the installation user must have permission for these directories. To change directories, click the browse button to the right of the directory field.
  3. Click Forward. The Select Components page opens. By default, all tools are selected. Deselect those components that you wish to not install.
  4. Enter the name of the server on which s-Server is installed.
  5. Click Forward. to begin the installation process. The installer displays a progress bar to show you how far along installation has progressed. Installation is complete when the progress bar reaches 100%. You will see a confirmation dialog box.
  6. Click Finish to exit the installer and/or view the Readme file.

Installing SQLstream s-Studio

By default, s-Studio installs as part of the s-Server package. These instructions are for installing s-Studio in a standalone context.

s-Studio is a client for s-Server which lets you view, query, and create streams, tables, views, pumps, and other objects. It installs on either Windows or Linux and communicates with s-Server via JDBC. While you can install SQLstream s-Studio as part of the s-Server installation, you can also install it on a separate machine, as long as that machine can reach s-Server via JDBC. SQLstream s-Studio can be installed on either Windows or Linux.

s-Studio Requirements

All SQLstream s-Studio system memory and disk requirements are above and beyond SQLstream Server system requirements when running on the same physical or virtual machine.

Component Details
Windows Windows 10. Both 32-bit and 64-bit versions are supported.
Linux A 2.6 or later Linux kernel distribution with Libc version 2.4 or later. Tested Linux kernel distributions include: CentOS 7.x, 8.x; Redhat Enterprise Linux 7.x, 8.x, Ubuntu 18.04 LTS (Bionic Beaver) and 20.04 LTS (Focal Fossa).

s-Studio is designed to run on any LSB compliant Linux, but specific distributions may or may not work
Disk space Installed software requires 1GB. Log files, repository, and so on require an additional 1 GB. The amount actually used will depend on how you configure logging, how many objects you create, and so on. 2GB is probably a safe minimum for an initial install. See SQLstream s-Server Installation Directories for more information on installation directories.
Memory 2G RAM. When running under VMWare, 2G physical RAM required on guest system.
Java A 32-bit or 64-bit JRE (Java Runtime Environment) version 8. Earlier or later versions of Java are not supported. Use the 32-bit JRE for 32-bit Windows s-Studio installations. Use the 64-bit JRE for 64-bit Windows or Linux s-Studio installations.

Installation Steps

The following instructions apply to Linux. Windows installation proceeds similarly.

  1. From a terminal prompt enter ./SQLstream-sStudio-X.Y.Z-x64.run, where X.Y.Z represent the release and version numbers, as in SQLstream-6.0.0, and x64 or x32 represents running on a 64-bit or 32-bit operating system. If it does not work, make sure the file is executable (by running chmod +x SQLstream-sStudio-X.Y.Z-x64.run), and try double-clicking the SQLstream icon again. If the installer still does not launch, it generally means JAVA_HOME is not in the default PATH, so the installer fails to find/run Java to execute the installer. Ensure that JAVA_HOME is in the default PATH and try double-clicking the icon again; A Welcome page appears, introducing the Setup Wizard.
  2. Click Forward. The SQLstream license text appears in a new dialog box.
  3. Click the radio button next to I accept and then click Forward. The Installation Directories page appears. This page lets you select directories for s-Studio. Note: the installation user must have permission for these directories. To change directories, click the browse button to the right of the directory field.
  4. Click Forward. The Default Server Host Name page appears. Enter the name of the server on which your installation of s-Server runs. If you do not know this location, please consult your system administrator.
  5. Click Forward to begin the installation process, which then displays a progress bar to show you how far along installation has progressed. Installation is complete when the progress bar reaches 100%. You will see a confirmation dialog box.
  6. Click Finish to exit the installer and/or view the Readme file.

When you launch s-Studio for the first time, you will need to enter connection information for your installation of s-Server.

Configuring s-Studio to Connect to s-Server

To configure s-Server to connect to s-Server:

Determine connection information for the s-Server instance. For example, if s-Server is installed locally, your system administrator will have this. If it is installed as an Amazon Machine Image, this will appear on the home page for the AMI.

  1. Right click on First SQLstream Server and choose Properties.
  2. Enter the JDBC URL for the s-Server instance.
  3. Click OK. The left pane of SQLstream s-Studio should populate with objects from the s-Server instance.

Uninstalling Client Tools

If you have installed Client Tools by themselves, the uninstaller will be located in $SQLSTREAM_HOME/clienttools where "SQLSTREAM_HOME" is the name of the installation directory.

As a result, you will need to alter the uninstallation command in a standalone installation. To uninstall Client Tools in a standalone installation, navigate to the installation directory and enter the following:

 ./SQLSTREAM_HOME/clienttools/uninstall

where "SQLSTREAM_HOME" is the name of the installation directory, such as opt/sqlstream/%Version%.XXX.  The unnstallation proceeds similarly to s-Studio uninstallation above.

s-Server asks for your verification by displaying the following dialog box:

When you click Yes, all client tools are uninstalled. When the process ends, it displays this dialog box:

Uninstalling s-Studio

If you have installed s-Studio by itself, the uninstaller will be located in $SQLSTREAM_HOME/studio where "SQLSTREAM_HOME" is the name of the installation directory.

As a result, you will need to alter the uninstallation command in a standalone installation. To uninstall s-Studio in a standalone installation, navigate to the installation directory and enter the following:

 ./SQLSTREAM_HOME/s-Studio/uninstall

where "SQLSTREAM_HOME" is the name of the installation directory, such as opt/sqlstream/%VERSION%.XXX. The uninstallation proceeds similarly to s-Server uninstallation above.

s-Server asks for your verification by displaying the following dialog box:


When you click Yes, s-Studio is uninstalled. If you have installed client tools with s-Studio, these are also uninstalled. When the process ends, it displays this dialog box: