Overview

The SQream DB UI provides a web interface for SQream DB monitoring and management, with a real-time view of some usage metrics of the SQream DB instance.

1.1. Key Benefits of using the SQream DB UI

  • Simplify SQream DB monitoring

  • Efficiently install the initial license

  • Easily query the system for ad-hoc usage

  • Simplify user and role management

1. SQream DB UI Architecture

The SQream DB UI is comprised of two browser-based applications:

  1. SQream DB Dashboard - The environment management application

  2. Statement Editor - The SQream DB management application

2. Installing and configuring the UI

The latest version of SQream DB comes with the UI already integrated. As such, it is not necessary to install the UI separately.

2.1. Activating the BYOL license

If you opted to run SQream DB with a BYOL license on AWS or Azure, you will need to activate your product first.

  1. Have your license file ready. You should receive this file from SQream Support. If you have not received your license, please contact [email protected] for further assistance.

  2. Open your browser and navigate to your instance URL on port 3001. The URL for your SQream DB web instance is the following:
    http://<SQream DB primary host IP>:3001.
    Thus, for example, if your AWS instance IP is 42.250.192.50, you will want to navigate to http://42.250.192.50:3001.

  3. You should see the Activation page. You can drag and drop the SQream DB license file.

  4. Once the file is uploaded, the activation will commence. This may take a few moments. You should see the following screen upon successful activation:

  5. Upon a successful activation, click the Login link to continue to the Administration Dashboard.
    Activation Success

The default credentials for AWS are:
Username: sqream
Password: <Your EC2 Instance ID>.

To find your EC2 Instance ID from the shell, run wget -q -O - http://169.254.169.254/latest/meta-data/instance-id

3. The SQream DB Dashboard

The dashboard is the environment management application. It allows the user the following actions:

  • View active processes

  • Monitor system vitals like storage and CPU usage

  • View the session history

  • Manage roles and permissions

  • Load data into SQream DB from CSV files

3.1. Logging in

Open your browser and navigate to your instance URL on port 3001. The URL for your SQream DB web instance is the following:
http://<SQream DB primary host IP>:3001.

You should see this login screen:

Login Modal
Figure 1. Login Screen

Enter your dashboard credentials and click the Log In button.

that these credentials are separate from the database credentials. See Dashboard User Management for more information.

If your credentials are correct, you will be greeted by the welcome screen.

Welcome Screen
Figure 2. Welcome Screen

3.2. The Dashboard

The dashboard contains several panels that show different aspects of the system. All panels update automatically. The refresh rate can be set up on the Dashboard Setup page.

3.2.1. Hosting Server

Hosting Panel
Figure 3. Hosting Panel

The hosting server panel displays information about the machine, OS and SQream DB services. The information includes:

  • SQream DB component status

  • System uptime

  • CPU usage

  • GPU utilization

  • Memory usage

These markers do not log historical data, and will only show information from the moment the dashboard page has been opened in your browser.
Manage SQream DB services

By clicking on the green Manage link, a dialog box will open, allowing life-cycle management of the services (start, stop, etc.)

3.2.2. Database Disk Distribution

The database disk distribution panel shows the disk-space used by each database in the SQream DB cluster.

3.2.3. Disk Usage

Disk Panel
Figure 4. Disk Panel

The disk usage panel shows the total disk-space used and available for the entire SQream DB cluster.

3.2.4. Active Statements

The active statements panel shows the current running statements, along with basic details like host:port, statement ID, the role running the statement and more.

Active Statements
Figure 5. Active Statements

You can stop a statement by clicking the stop icon on the statement line.

3.2.5. Last Statements

The Last statements panel shows the last 30 statements, as they appear in the SQream DB log. This includes both successful and failed statements.

Active Statements
Figure 6. Last Statements
The number of statements that appear in this list can be changed in the Dashboard Setup page, from 10 to 90.

3.3. Importing a CSV

The Import CSV tool assists in uploading CSV files into SQream DB. It is designed as a 4-step wizard:

Import CSV
Figure 7. Import CSV

3.3.1. Select CSV source

Select source file - start by selecting your CSV file. You may either upload the file to the server yourself, or upload it through the web interface.

Choose the Directory checkbox to import an existing directory containing CSV files with the .csv extension.

3.3.2. Import setting

In Import setting dialog box allows for setting parameters for the bulk load process.

Basic settings include

  • Delimiter - Choose the correct file delimiter, like ,, \t, |, or other single character.

  • Header line - Check this checkbox to skip the first line of the file

More advanced settings are accessible via Advanced Settings link.

Refer to SQream SQL Reference Guide under the "COPY FROM (bulk import)” section for more information about these settings.

3.3.3. Select Target

The Select Target dialog lets you choose the target database and table. It also previews the first few rows from the file for verification.

Selecting the correct target for bulk import
  1. Select the target database

  2. Select target table

  3. Map the columns
    Once the table is selected, the columns will be displayed on the left-hand list (under All columns)

    1. Select the column by clicking the + icon by each column, or by using SELECT ALL.

    2. You may also search for specific columns by using the search bar.

  4. Reorder columns or remove columns:
    After selecting columns, you can also remove them by clicking the X icon.
    Drag and drop the selected columns to reorder them for input.

Clicking the Next button will begin the import.

3.3.4. Results

This page will open once import has begun, to display the progress.

Upon completion, the result will be shown.

Any error during import will display the path to the error log written.

3.4. Role management

The Role Management screen provides a tool to create and manage SQream DB roles and permissions.

More information about SQream DB’s roles and permissions system can be found in our SQL Reference Guide under the "Managing Database Roles and Permissions" section.

Role Management
Figure 8. Role Management

3.4.1. Adding a new role

Add a new role by clicking the ADD NEW button.

Fill in the required details and click SAVE when done.

A role that isn’t designed for LOGIN permissions does not require a password.

3.4.2. Updating an existing role

The main display will list all existing roles in SQream DB. Each line has an Edit button, which will open the update dialog.

Leave the password fields unchanged to avoid updating the password.

Click SAVE to commit the changes.

3.4.3. Update role permissions

The Permissions link in the roles table will open the roles management dialog.

SQL Preview

It is possible to preview the SQL query for the upcoming changes, by clicking the SHOW SQL button.

After changing permissions, commit the changes by clicking the SAVE button.

This will issue one or more SQL statements, depending on the changes you have made.

The system will print out all the statements issued. Any unsuccessful statement will be colored red, with the error printed by it.

Role Inheritance

To inherit one role to the other, edit the role you’d like to You can assign roles to other roles (inherit one role to other). In the role sections, check or uncheck roles that you would like to inherit from, to the current role.

Databases, Schemas, Tables

In this section, you can GRANT and REVOKE permissions on the database level.

Upon selecting a database and schemas, all tables will be shown - allowing GRANT and REVOKE operations.

3.4.4. Dropping a Role

Click on Drop to drop a role. You will see a confirmation dialog. If this role is being used, the system will show you the dependent roles.

You can force a drop by selecting the DROP ROLE button.

3.5. Dashboard user management

The dashboard user management page allows you to administer the users who can access the SQream DB dashboard.

Dashboard Users
Figure 9. Dashboard Users
This user system is separate to the SQream DB roles. You may let a user access the dashboard, without accessing SQream DB.

3.6. Dashboard Setup

The dashboard setup page lets you set parameters relating to the dashboard views and refresh rates.

Dashboard Setup
Figure 10. Dashboard Setup

3.6.1. Dashboard Refresh Rate

You can set refresh rate of each element in the dashboard, to be either a specific interval, or manually updated.

3.6.2. SQream DB Log

By default, all statements sent to SQream DB are written into the log. However, by default, the dashboard queries are not. If you wish to override this behavior, you can alter these settings:

  • Log statements submitted from dashboard: When on, all dashboard queries will be logged, but not displayed in the dashboard.

  • Show statements submitted from dashboard: When on, all logged statements will be displayed in the dashboard.

This dashboard application uses a role called dashboard. Please do not remove this role.

3.6.3. Other Settings

  • Hosting serve Ticks: how many ticks will be shown in the Hosting server panel (for CPU, GPU and memory).
    The refresh rate for this setting appears under Dashboard Refresh Rate, to the left.

  • Dashboard Last statements: how many statements will be fetch on “Last Statements box” in dashboard.

3.7. Show Locks

This page lets you see the active locks in the database.

Show Locks
Figure 11. Show Locks

Select the desired database and click the FETCH button. You may also filter by table or role.

You can stop a selected locking statement by clicking the STOP button alongside the statement.

4. Statement Editor

The statement editor is a multi-tab, multi-results statement editor for SQream DB.

4.1. Logging in

Login with your SQream DB credentials, including username, password, and database name.

If this is your first connection, the master database is a built-in database.

The default credentials for AWS are:
Username: sqream
Password: <Your EC2 Instance ID>.

4.2. Using the Statement Editor

The statement editor contains these elements:

  1. Toolbar - select a database, run statements and other actions

  2. Editor - write your statements here

  3. Results Panel - shows the results of the last query

  4. DB Tree - shows the database structure

4.2.1. Toolbar

  1. Toggle DB Tree - show or hide the database structure

  2. Database selector - dropdown box that allows you to select the currently active database

  3. Run/Stop button* - run or stop a query

  4. Max. Rows - allows you to limit the size of the result set

  5. Save/Load buttons - save the contents of the editor to your computer, or load content into the editor

  6. Setting menu

    1. Append new results - when checked, each query will open a new result tab, instead of replacing the current tab