Connect with the SingleStore Client
On this page
Note
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.
Connect to Your SingleStore Helios Workspace
The singlestore_
file is required to configure an SSL connection.
-
Download the
singlestore_
file.bundle. pem -
Log into the Cloud Portal.
-
Click on your workspace.
-
Click the Connect button in the top right-hand corner of your workspace's dashboard.
-
Under TLS/SSL Certificate, click the Download link.
This will download the singlestore_
file to your computer.bundle. pem
-
-
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 statuswhere:
-
client-endpoint
is the SingleStore Helios endpoint for your workspace -
port
is the port number to connect on (typically3306
) -
database-user
is either the database user to connect as, or the defaultadmin
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 wrapperConnection id: 17323Current database:Current user: admin@SSL: Cipher in use is AES128-GCM-SHA256Current pager: stdoutUsing outfile: ''Using delimiter: ;Server version: 5.7.32 MemSQL source distribution (compatible; MySQL Enterprise & MySQL Commercial)Protocol version: 10Connection: <your-workspace-endpoint> via TCP/IPServer characterset: utf8Db characterset: utf8Client characterset: utf8Conn. characterset: utf8TCP port: 3306-------------- -
-
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.pemWhen connected, the following (or similar) output will be displayed.
Welcome to the MySQL monitor. Commands end with ; or \g.Your MySQL connection id is 7168Server 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 itsaffiliates. Other names may be trademarks of their respectiveowners.Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.singlestore>
Last modified: June 28, 2023