Command Line Programs

SQream contains several command line programs for using, starting, managing, and configuring SQream clusters.

The Command Line Programs page provides a reference for these programs, as well as flags and configuration settings.

User CLIs

Command

Usage

sqream sql

Built-in SQL client

SQream Cluster Components

Command

Usage

sqreamd

Start a SQream DB worker

metadata_server

The cluster manager/coordinator that enables scaling SQream DB.

server_picker

Load balancer end-point

SQream Utilities

Command

Usage

SqreamStorage

Initialize a cluster and set superusers

upgrade_storage

Upgrade metadata schemas when upgrading between major versions

Docker Utilities

Command

Usage

sqream_console

Dockerized convenience wrapper for operations

sqream_installer

Dockerized installer