Connect with the SingleStore Client


When using the SingleStore client, or a third-party SQL client, you must first add a database user to log into a SingleStore Helios database.

The SingleStore client, similar to the MySQL client, is a lightweight Linux application that allows you to connect to SingleStore Helios and run SQL queries directly from a terminal session.

Use singlestore --help to for help and to view additional connection options.

Install SingleStore Client

Connect to Your SingleStore Helios Workspace

The singlestore_bundle.pem file is required to configure an SSL connection. Once downloaded, this file can be used to connect to all of your SingleStore Helios workspaces via SSL.

  1. Download the singlestore_bundle.pem file.

    1. Log into the Cloud Portal.

    2. Click on your workspace.

    3. Click the Connect button in the top right-hand corner of your workspace's dashboard.

    4. Under TLS/SSL Certificate, click the Download link. This will download the singlestore_bundle.pem file to your computer.

  2. To confirm that the connection is using SSL, run the following command to check the connection status.

    singlestore -h <client-endpoint> -P <port> -u <database-user> -p<database-user-password> --ssl-ca=singlestore_bundle.pem \
    -e status


    • client-endpoint is the SingleStore Helios endpoint for your workspace

    • port is the port number to connect on (typically 3306)

    • database-user is either the database user to connect as, or the default admin user (which was created with the workspace)

    • database-user-password is the database user password.

      You may receive the following message when including the database user password on the command line:

      singlestore-client: [Warning] Using a password on the command line interface can be insecure.

      To prevent this message, leave the database user password blank and you will be prompted for the password.

    From the output, review the SSL line for the cipher in use.

    /usr/lib/singlestore-client/singlestore-client Ver 14.14 Distrib 5.7.17, for Linux (x86_64) using EditLine wrapper
    Connection id: 17323
    Current database:
    Current user: admin@
    SSL: Cipher in use is AES128-GCM-SHA256
    Current pager: stdout
    Using outfile: ''
    Using delimiter: ;
    Server version: 5.7.32 MemSQL source distribution (compatible; MySQL Enterprise & MySQL Commercial)
    Protocol version: 10
    Connection: <your-workspace-endpoint> via TCP/IP
    Server characterset: utf8
    Db characterset: utf8
    Client characterset: utf8
    Conn. characterset: utf8
    TCP port: 3306
  3. Run the following command to connect to your SingleStore Helios workspace.

    Note that this is the same command and parameters from Step 2, only without the -e status flag.

    singlestore -h <client-endpoint> -P <port> -u <database-user> -p<database-user-password> --ssl-ca=singlestore_bundle.pem

    When connected, the following (or similar) output will be displayed.

    Welcome to the MySQL monitor. Commands end with ; or \g.
    Your MySQL connection id is 7168
    Server version: 5.7.32 MemSQL source distribution (compatible; MySQL Enterprise & MySQL Commercial)
    Copyright (c) 2000, 2016, Oracle and/or its affiliates. All rights reserved.
    Oracle is a registered trademark of Oracle Corporation and/or its
    affiliates. Other names may be trademarks of their respective
    Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.

Upgrade SingleStore Client

Uninstall SingleStore Client

Last modified: June 28, 2023

Was this article helpful?